NetApp Manage ONTAP

APIs in Category: active-directory | Vserver API version 1.21

active-directory-account-create active-directory-account-delete active-directory-account-get-iter active-directory-account-modify active-directory-account-password-change active-directory-account-password-reset | This set of ZAPIs allows creating an Active Directory account and manage them. It is only used when a full CIFS server is not desired or not available.

active-directory-account-create | [top]

> Create an Active Directory account for the given Vserver. If a CIFS server already exists for the requested Vserver, then this command will fail. The existing CIFS server should be deleted before retrying again.

> Input Name | Range | Type | Description
> account-name |  | netbios-name | Active Directory account NetBIOS name.
> admin-password |  | string | Administrator password required for Active Directory account creation.
> admin-username |  | string | Administrator username required for Active Directory account creation.
> domain |  | string | Fully qualified domain name.
> force-account-overwrite |  | boolean optional | If true and a machine account with the same name as specified in 'account-name' exists in Active Directory, it will be overwritten and reused. The default value for this field is false.
> organizational-unit |  | string optional | Organizational unit under which the Active Directory account will be created.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |
> ECIFS_CIFS_SERVER_ALREADY_EXISTS |  |

active-directory-account-delete | [top]

> Delete the Active Directory account. If a CIFS server already exists for the requested Vserver, cifs-server-delete API should be used to delete the machine account.

> Input Name | Range | Type | Description
> admin-password |  | string optional | Administrator password required for Active Directory account deletion.
> admin-username |  | string optional | Administrator username required for Active Directory account deletion.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

active-directory-account-get-iter | [top]

> Retrieve the list of active directory accounts

> Input Name | Range | Type | Description
> desired-attributes |  | active-directory-account-config optional | Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | active-directory-account-config optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the active-directory-account object. All active-directory-account objects matching this query up to 'max-records' will be returned.
> tag |  | string optional | Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
> Output Name | Range | Type | Description
> attributes-list |  | active-directory-account-config[] optional | The list of attributes of active-directory-account objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more active-directory-account objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

active-directory-account-modify | [top]

> Modify the Windows Active Directory domain. If a CIFS server already exists for the requested Vserver, cifs-server-modify API should be used to modify the Windows Active Directory domain.

> Input Name | Range | Type | Description
> admin-password |  | string optional | Administrator password required for Active Directory account creation in the given domain.
> admin-username |  | string optional | Administrator username required for Active Directory account creation in the given domain.
> domain |  | string optional | Fully qualified domain name.
> force-account-overwrite |  | boolean optional | If true and a machine account with the same name as specified in 'account-name' exists in Active Directory, it will be overwritten and reused. The default value for this field is false.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

active-directory-account-password-change | [top]

> Generate a new password for the machine account and change it in the Windows Active Directory domain.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

active-directory-account-password-reset | [top]

> Reset the machine account password in the Windows Active Directory domain. This may be required if the password stored along with the machine account in the Windows Active Directory domain is changed or reset without the Vserver's knowledge. This operation requires the credentials for a user with permission to reset the password in the organizational unit (OU) that the machine account is a member of.

> Input Name | Range | Type | Description
> admin-password |  | string | Administrator password required for Active Directory account password reset.
> admin-username |  | string | Administrator username required for Active Directory account password reset.

> Errno | Description
> EOBJECTNOTFOUND |  |
> EINTERNALERROR |  |

Element definition: active-directory-account-config | [top]

> Active Directory configuration information for the Vserver. When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller. When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved. When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

> Name | Range | Type | Description
> account-name |  | netbios-name optional | Active Directory account NetBIOS name. Attributes: required-for-create, non-modifiable
> domain |  | string optional | Fully qualified domain name. Attributes: required-for-create, modifiable
> domain-workgroup |  | domain-name optional | NetBios domain/workgroup name. Attributes: non-creatable, non-modifiable
> organizational-unit |  | string optional | Organizational unit under which the Active Directory account resides. Attributes: optional-for-create, non-modifiable
> vserver |  | string optional | Vserver Attributes: key, non-creatable, non-modifiable

Element definition: netbios-name | [top]

> Name of a client or a server participating in a NetBIOS Windows File sharing service network. This can be different from the host name.

> [none]

Element definition: domain-name | [top]

> The domain name is an identification label that defines a realm based on Domain Name Service (DNS).

> [none]