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

Retrieve the CIFS domain preferred DC configuration for an SVM and domain

Contributors
PDFs

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

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

fqdn

string

path

True

Fully Qualified Domain Name

server_ip

string

path

True

Domain Controller IP address

need_status

boolean

query

False

Retrieves the status of the specified preferred DC.

  • Introduced in: 9.12

  • Default value:

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

fields

array[string]

query

False

Specify the fields to return.

Response

Status: 200, Ok
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.
Example response 
{
  "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

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

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.

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.