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

Retrieve an Active Directory preferred DC configuration for an SVM and domain

Contributors
PDFs

GET /protocols/active-directory/{svm.uuid}/preferred-domain-controllers/{fqdn}/{server_ip}

Introduced In: 9.12

Retrieves the Active Directory preferred DC configuration of an SVM.

  • vserver active-directory preferred-dc show

Parameters

Name Type In Required Description

fqdn

string

path

True

Fully Qualified Domain Name.

server_ip

string

path

True

DC's IP address.

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 DC. The address can be either an IPv4 or an IPv6 address.
Example response 
{
  "fqdn": "test.com",
  "server_ip": "4.4.4.4"
}

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

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.