Skip to main content
A newer release of this product is available.

Retrieve the CIFS domain preferred DC configuration for an SVM

Contributors
PDFs

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

Introduced In: 9.10

Retrieves the CIFS domain preferred DC configuration of an SVM.

  • vserver cifs domain preferred-dc show

  • vserver cifs domain preferred-dc check

Learn more

Parameters

Name Type In Required Description

need_status

boolean

query

False

Retrieves the status of the preferred DCs.

  • Default value:

  • Introduced in: 9.12

server_ip

string

query

False

Filter by server_ip

status.reachable

boolean

query

False

Filter by status.reachable

  • Introduced in: 9.12

status.details

string

query

False

Filter by status.details

  • Introduced in: 9.12

fqdn

string

query

False

Filter by fqdn

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

max_records

integer

query

False

Limit the number of records returned.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

_links

num_records

integer

Number of CIFS preferred domain controller records.

records

array[cifs_domain_preferred_dc]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "num_records": 1,
  "records": {
    "fqdn": "test.com",
    "server_ip": "4.4.4.4",
    "status": {
      "details": "Response time (msec): 111",
      "reachable": 1
    }
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

next

href

self

href

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.

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.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

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.