APIs in Category: ndmp | Vserver API version 1.20

ndmp-password-generate

ndmp-password-generate | [top]

> Generate NDMP password for the given user in a specific Vserver context. The generated NDMP password is based on the actual login password for the user; hence it should be regenerated whenever the actual user password is changed.

> Input Name | Range | Type | Description
> desired-attributes |  | ndmp-password-info 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.
> user-name |  | string | The user for which the password is to be generated.
> Output Name | Range | Type | Description
> attributes |  | ndmp-password-info | The attributes of the ndmp-password.

> Errno | Description
> EOBJECTNOTFOUND |
> EINTERNALERROR |

Element definition: ndmp-password-info | [top]

> Information about generate password 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
> password |  | string optional | The generated NDMP password for the given user. The command fails if such a user does not exist in the Vserver context. Attributes: non-creatable, non-modifiable
> user-name |  | string optional | The user for which the password is to be generated. Attributes: key, non-creatable, non-modifiable
> vserver-name |  | string optional | The Vserver on which the user password is to be generated for the given user. Attributes: key, non-creatable, non-modifiable