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

Modify an Active Directory account for an SVM

PDFs

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

Introduced In: 9.12

Modifies the Active Directory account for a given SVM.

  • vserver active-directory modify

Important notes

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

Parameters

Name Type In Required Description

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

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.

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.

username

string

Administrator username required for Active Directory account creation, modification and deletion.
Example request 
{
  "discovered_servers": [
    {
      "domain": "server1.com",
      "node": {
        "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",
  "password": "testpwd",
  "preferred_dcs": [
    {}
  ],
  "username": "admin"
}

Response

Status: 200, Ok
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.

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.

username

string

Administrator username required for Active Directory account creation, modification and deletion.
Example response 
{
  "discovered_servers": [
    {
      "domain": "server1.com",
      "node": {
        "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",
  "password": "testpwd",
  "preferred_dcs": [
    {}
  ],
  "username": "admin"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

656464

Failed to modify 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 modify the Active Directory machine account. Reason: Organizational-Unit not found.

656478

Failed to create the Active Directory machine account. Reason: KDC has no support for encryption type.

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

Definitions

See Definitions

href

Name Type Description

href

string

_links

node

Name Type Description

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

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

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.

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.

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.