APIs in Category: security-ssl | Cluster-Mode API version 1.20

security-ssl-get-iter security-ssl-modify | This is an auto generated category.

NetApp Manage ONTAP

security-ssl-get-iter | [top]

> Get the attributes of SSL security

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

> Errno | Description
> EINTERNALERROR |  |

security-ssl-modify | [top]

> Modify SSL authentication for a Vserver. Only field(s) that are provided will be modified.

> Input Name | Range | Type | Description
> certificate-authority |  | string optional | Issuing Certificate Authority (CA) of server certificate. This field is required when you specify server-enabled as true.
> certificate-serial-number |  | string optional | Serial number of certificate in hexadecimal format. This field is required when you specify server-enabled as true, if you do not specify one it will use the serial number of the default certificate.
> client-authentication-enabled |  | boolean optional | Informs if SSL Client Authentication is enabled.
> common-name |  | string optional | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). This field is optional when you specify server-enabled as true.
> server-authentication-enabled |  | boolean optional | Informs if SSL Server Authentication is enabled.
> vserver |  | string optional | Name of vserver.

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

Element definition: vserver-ssl-info | [top]

> Information about SSL authentication for a 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
> certificate-authority |  | string optional | Issuing Certificate Authority (CA) of server certificate. This field is required when you specify server-enabled as true. Attributes: non-creatable, modifiable
> certificate-serial-number |  | string optional | Serial number of certificate in hexadecimal format. This field is required when you specify server-enabled as true. Attributes: non-creatable, modifiable
> client-authentication-enabled |  | boolean optional | Informs if SSL Client Authentication is enabled. Attributes: non-creatable, modifiable
> common-name |  | string optional | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS). This field is optional when you specify server-enabled as true. Attributes: non-creatable, modifiable
> server-authentication-enabled |  | boolean optional | Informs if SSL Server Authentication is enabled. Attributes: non-creatable, modifiable
> vserver |  | string optional | Name of vserver. Attributes: key, non-creatable, non-modifiable