NetApp Manage ONTAP

APIs in Category: security | Vserver API version 1.21

security-login-modify-password security-ssh-add security-ssh-get-iter security-ssh-remove security-ssh-reset | This set of ZAPIs allow to manage security of the system.

security-login-modify-password | [top]

> Changes the password of a specified user.

> Input Name | Range | Type | Description
> new-password |  | string | New password of the user.
> user-name |  | string optional | The user whose password should be changed. This is mandatory when a user with admin role is modifying the password of another user.

> Errno | Description
> EINTERNALERROR |  |
> EINVALIDPASSWORD |  |
> EONTAPI_EPERM |  |

security-ssh-add | [top]

> Adds the input algorithms and ciphers to the SSH configuration. Existing algorithms and ciphers remain in the configuration. API will succeed if requested algorithm or cipher is not currently enabled in the configuration.

> Input Name | Range | Type | Description
> ciphers |  | ciphers[] optional | List of SSH Ciphers to Add
> key-exchange-algorithms |  | kex-algorithms[] optional | List of SSH Key Exchange Algorithms to Add
> vserver |  | vserver-name optional | Name of Vserver.

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

security-ssh-get-iter | [top]

> Display SSH configuration options

> Input Name | Range | Type | Description
> desired-attributes |  | security-ssh-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.
> max-records | [1..2^32-1] | integer optional | The maximum number of records to return in this call. Default: 20
> query |  | security-ssh-info optional | A query that specifies which objects to return. A query could be specified on any number of attributes in the ssh object. All ssh 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 |  | security-ssh-info[] optional | The list of attributes of ssh objects.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more ssh objects to return.
> num-records | [0..2^32-1] | integer | The number of records returned in this call.

> Errno | Description
> EINTERNALERROR |  |

security-ssh-remove | [top]

> Removes the input algorithms and ciphers from the SSH configuration. API will succeed if requested algorithm or cipher is already currently enabled in the configuration.

> Input Name | Range | Type | Description
> ciphers |  | ciphers[] optional | List of SSH Ciphers to Remove
> key-exchange-algorithms |  | kex-algorithms[] optional | List of SSH Key Exchange Algorithms to Remove
> vserver |  | vserver-name optional | Name of Vserver.

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

security-ssh-reset | [top]

> Enable and replace SSH configuration options to this new setting

> Input Name | Range | Type | Description
> ciphers |  | ciphers[] optional | List of SSH Ciphers enabled. Possible values: "aes256_ctr" , "aes192_ctr" , "aes128_ctr" , "aes256_cbc" , "aes192_cbc" , "aes128_cbc" , "3des_cbc"
> key-exchange-algorithms |  | kex-algorithms[] optional | List of SSH key exchange algorithms enabled. Possible values: "diffie_hellman_group_exchange_sha256" , "diffie_hellman_group_exchange_sha1" , "diffie_hellman_group14_sha1" , "diffie_hellman_group1_sha1"

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

Element definition: ciphers | [top]

> cipher name Possible values: "aes256_ctr" , "aes192_ctr" , "aes128_ctr" , "aes256_cbc" , "aes192_cbc" , "aes128_cbc" , "3des_cbc"

> [none]

Element definition: kex-algorithms | [top]

> algorithm name Possible values: "diffie_hellman_group_exchange_sha256" , "diffie_hellman_group_exchange_sha1" , "diffie_hellman_group14_sha1" , "diffie_hellman_group1_sha1"

> [none]

Element definition: security-ssh-info | [top]

> Provide SSH configuration 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
> ciphers |  | ciphers[] optional | List of SSH Ciphers enabled. Attributes: optional-for-create, modifiable Possible values: "aes256_ctr" , "aes192_ctr" , "aes128_ctr" , "aes256_cbc" , "aes192_cbc" , "aes128_cbc" , "3des_cbc"
> key-exchange-algorithms |  | kex-algorithms[] optional | List of SSH key exchange algorithms enabled. Attributes: optional-for-create, modifiable Possible values: "diffie_hellman_group_exchange_sha256" , "diffie_hellman_group_exchange_sha1" , "diffie_hellman_group14_sha1" , "diffie_hellman_group1_sha1"
> vserver-name |  | vserver-name optional | Name of Vserver. Attributes: key, non-creatable, non-modifiable

Element definition: vserver-name | [top]

> The name of the Vserver.

> [none]

Element definition: ciphers | [top]

> cipher name Possible values: "aes256_ctr" , "aes192_ctr" , "aes128_ctr" , "aes256_cbc" , "aes192_cbc" , "aes128_cbc" , "3des_cbc"

> [none]

Element definition: kex-algorithms | [top]

> algorithm name Possible values: "diffie_hellman_group_exchange_sha256" , "diffie_hellman_group_exchange_sha1" , "diffie_hellman_group14_sha1" , "diffie_hellman_group1_sha1"

> [none]