Skip to main content
REST API reference

Create the CIFS domain preferred DC configuration for an SVM

PDFs

POST /protocols/cifs/domains/{svm.uuid}/preferred-domain-controllers

Introduced In: 9.10

Creates a CIFS preferred DC configuration for an SVM.

Important notes

  • In the case of bulk POST requests, the create operation should be performed serially since there can be interdependence between records. In order to avoid issues, it is advisable to always use the query parameter "serial_records=true".

Required properties

  • svm.uuid - Existing SVM in which to create the preferred-dc.

  • domain - Fully Qualified Domain Name.

  • server_ip - IPv4/IPv6 address of the Preferred Domain Controller.

The following parameters are optional:

  • skip_config_validation

  • vserver cifs domain preferred-dc add

Learn more

Parameters

Name Type In Required Description

skip_config_validation

boolean

query

False

Skip the validation of the specified preferred DC configuration.

  • Default value:

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

fqdn

string

Fully Qualified Domain Name.

server_ip

string

IP address of the preferred domain controller (DC). The address can be either an IPv4 or an IPv6 address.

status

status

Status of CIFS preferred domain controller.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "fqdn": "test.com",
  "server_ip": "4.4.4.4",
  "status": {
    "details": "Response time (msec): 111",
    "reachable": 1
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 201, Created
Name Type Description

fqdn

string

Fully Qualified Domain Name.

server_ip

string

IP address of the preferred domain controller (DC). The address can be either an IPv4 or an IPv6 address.

status

status

Status of CIFS preferred domain controller.

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "fqdn": "test.com",
  "server_ip": "4.4.4.4",
  "status": {
    "details": "Response time (msec): 111",
    "reachable": 1
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

2621516

Only data SVMs allowed.

655918

The fully qualified domain name cannot be longer than 254 bytes.

656408

RPC failure occurred during the CIFS preferred-dc configuration validation.

656407

Failed to validate CIFS preferred-dc for domain. Reason: Configuration not found at SecD. Contact technical support for assistance.

655366

Invalid domain controller.

655506

Failed to add preferred-dc.

Definitions

See Definitions

status

Status of CIFS preferred domain controller.

Name Type Description

details

string

Provides a detailed description of the state if the state is 'down' or the response time of the DNS server if the state is 'up'.

reachable

boolean

Indicates whether or not the domain controller is reachable.

href

Name Type Description

href

string

_links

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

cifs_domain_preferred_dc

Name Type Description

fqdn

string

Fully Qualified Domain Name.

server_ip

string

IP address of the preferred domain controller (DC). The address can be either an IPv4 or an IPv6 address.

status

status

Status of CIFS preferred domain controller.

svm

svm

SVM, applies only to SVM-scoped objects.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.