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

Create an Active Directory account for an SVM

Contributors
PDFs

POST /protocols/active-directory

Introduced In: 9.12

Creates an Active Directory account for a given SVM.

  • vserver active-directory create

Important notes

  • Active Directory account creation is asynchronous. Response contains Task UUID and Link that can be queried to get the status.

Parameters

Name Type In Required Description

return_records

boolean

query

False

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

  • Default value:

Request Body

Name Type Description

discovered_servers

array[discovered_servers]

Specifies the discovered servers records.

force_account_overwrite

boolean

If set to true and a machine account exists with the same name as specified in "name" in Active Directory, it will be overwritten and reused.

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.

password

string

Administrator password required for Active Directory account creation, modification and deletion.

preferred_dcs

array[preferred_dcs]

Specifies the preferred domain controller (DC) records.

svm

svm

SVM, applies only to SVM-scoped objects.

username

string

Administrator username required for Active Directory account creation, modification and deletion.
Example request 
{
  "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",
  "password": "testpwd",
  "preferred_dcs": [
    {
      "fqdn": "test.com",
      "server_ip": "4.4.4.4"
    }
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "username": "admin"
}

Response

Status: 201, Created
Name Type Description

discovered_servers

array[discovered_servers]

Specifies the discovered servers records.

force_account_overwrite

boolean

If set to true and a machine account exists with the same name as specified in "name" in Active Directory, it will be overwritten and reused.

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.

password

string

Administrator password required for Active Directory account creation, modification and deletion.

preferred_dcs

array[preferred_dcs]

Specifies the preferred domain controller (DC) records.

svm

svm

SVM, applies only to SVM-scoped objects.

username

string

Administrator username required for Active Directory account creation, modification and deletion.
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",
  "password": "testpwd",
  "preferred_dcs": [
    {
      "fqdn": "test.com",
      "server_ip": "4.4.4.4"
    }
  ],
  "svm": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  },
  "username": "admin"
}

Headers

Name Description Type

Location

Useful for tracking the resource location

string

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

655562

The NetBIOS name cannot be longer than 15 characters.

655915

A CIFS server for this SVM already exists. Having both a CIFS server and an Active Directory account for the same SVM is not supported. Use the \"vserver cifs delete\" command to delete the existing CIFS server and try the command again.

656464

Failed to create the Active Directory machine account. Reason: Invalid Credentials.

656465

Failed to create the Active Directory machine account. Reason: An account with this name already exists.

656466

Failed to create the Active Directory machine account. Reason: Unable to connect to any domain controllers.

656467

Failed to create the Active Directory machine account. Reason: Organizational-Unit not found.

Also see the table of common errors in the Response body overview section of this documentation.

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.

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.

active_directory

Name Type Description

discovered_servers

array[discovered_servers]

Specifies the discovered servers records.

force_account_overwrite

boolean

If set to true and a machine account exists with the same name as specified in "name" in Active Directory, it will be overwritten and reused.

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.

password

string

Administrator password required for Active Directory account creation, modification and deletion.

preferred_dcs

array[preferred_dcs]

Specifies the preferred domain controller (DC) records.

svm

svm

SVM, applies only to SVM-scoped objects.

username

string

Administrator username required for Active Directory account creation, modification and deletion.

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.