NetApp Manage ONTAP

APIs in Category: active-directory | Cluster-Mode API version 1.21

active-directory-account-get-iter | 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-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 |  |

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: domain-name | [top]

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

> [none]

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]