Skip to main content
REST API reference

Retrieve an Active Directory account for an SVM

PDFs

GET /protocols/active-directory/{svm.uuid}

Introduced In: 9.12

Retrieves the Active Directory account for a given SVM.

  • vserver active-directory show

  • vserver active-directory preferred-dc show

  • vserver active-directory discovered-servers show

  • vserver active-directory discovered-servers reset-servers

  • vserver cifs security show

Parameters

Name Type In Required Description

reset_discovered_servers

boolean

query

False

Force a rediscovery.

  • 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

discovered_servers

array[discovered_servers]

Specifies the discovered servers records.

fqdn

string

Fully qualified domain name.

name

string

Active Directory (AD) account NetBIOS name.

organizational_unit

string

Organizational unit under which the Active Directory account will be created.

preferred_dcs

array[preferred_dcs]

Specifies the preferred domain controller (DC) records.

security

active_directory_security

svm

svm

SVM, applies only to SVM-scoped objects.
Example response 
{
  "discovered_servers": [
    {
      "domain": "server1.com",
      "node": {
        "_links": {
          "self": {
            "href": "/api/resourcelink"
          }
        },
        "name": "node1",
        "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
      },
      "preference": "preferred",
      "server": {
        "ip": "7.4.3.1",
        "name": "scspk0659102001",
        "type": "kerberos"
      },
      "state": "ok"
    }
  ],
  "force_account_overwrite": "",
  "fqdn": "server1.com",
  "name": "account1",
  "organizational_unit": "CN=Test",
  "preferred_dcs": [
    {
      "fqdn": "test.com",
      "server_ip": "4.4.4.4"
    }
  ],
  "security": {
    "advertised_kdc_encryptions": [
      "string"
    ]
  },
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

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

href

Name Type Description

href

string

_links

Name Type Description

self

href

node

Name Type Description

_links

_links

name

string

uuid

string

active_directory_discovered_server_reference

Name Type Description

ip

string

The IP address of the server that was discovered.

name

string

Server Name

type

string

The type of the server that was discovered.

discovered_servers

Name Type Description

domain

string

The Active Directory domain that the discovered server is a member of.

node

node

preference

string

The preference level of the server that was discovered.

server

active_directory_discovered_server_reference

state

string

The status of the connection to the server that was discovered.

preferred_dcs

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.

active_directory_security

Name Type Description

advertised_kdc_encryptions

array[string]

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

_links

_links

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.

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.