APIs in Category: security-certificate | Vserver API version 1.20

security-certificate-ca-issued-get security-certificate-ca-issued-get-iter security-certificate-create security-certificate-delete security-certificate-delete-iter security-certificate-generate-csr security-certificate-get security-certificate-get-iter security-certificate-install security-certificate-revoke security-certificate-sign | This set of ZAPIs allows to manage certificates in a cluster enviornment including: creation, deletion, installation, generation of CSR, signing of certificate and revocation.

NetApp Manage ONTAP

security-certificate-ca-issued-get | [top]

> Get the attributes of the security-certificate-ca-issued.

> Input Name | Range | Type | Description
> ca-serial-number |  | string | Serial number of CA certificate.
> certificate-authority |  | string | Certificate Authority
> desired-attributes |  | certificate-ca-issued-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.
> serial-number |  | string | Serial number of certificate.
> Output Name | Range | Type | Description
> attributes |  | certificate-ca-issued-info | The attributes of the security-certificate-ca-issued.

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

security-certificate-ca-issued-get-iter | [top]

> Iterate over a list of security-certificate-ca-issued objects.

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

> Errno | Description
> EINTERNALERROR |  |

security-certificate-create | [top]

> If a certificate is created with the existing Common Name then a new certificate is generated with a different serial number

> Input Name | Range | Type | Description
> common-name |  | string | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
> country |  | string optional | Name of the country. Default value is 'US'.
> email-address |  | string optional | Email address of administrator. Default value is empty string.
> expire-days |  | integer optional | Number of days until expiration. Default value is '365'.
> hash-function |  | string optional | Hashing function used to sign the certificate. Default value is 'sha256'. Possible values: 'sha1' , 'sha256' , 'md5'
> locality |  | string optional | Name of the locality Default value is empty string.
> organization |  | string optional | Name of the organization. Default value is empty string.
> organization-unit |  | string optional | Name of the unit. Example: IT, Finance. Default value is empty string.
> size |  | string optional | Size of requested certificate in bits. Default value is '2048'. Possible values: '512' - 512 bits private key, '1024' - 1024 bits private key, '1536' - 1536 bits private key, '2048' - 2048 bits private key
> state |  | string optional | Name of the state. Default value is empty string.
> type |  | string | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication
> vserver |  | string optional | Name of vserver.

> Errno | Description
> EINTERNALERROR |  |

security-certificate-delete | [top]

> Delete an existing security-certificate object.

> Input Name | Range | Type | Description
> certificate-authority |  | string | Certificate Authority
> common-name |  | string | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
> serial-number |  | string optional | Serial number of certificate.
> type |  | string | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication
> vserver |  | string optional | Name of vserver.

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

security-certificate-delete-iter | [top]

> Delete an existing security-certificate or a group of security-certificate objects.

> Input Name | Range | Type | Description
> continue-on-failure |  | boolean optional | This input element is useful when multiple security-certificate objects match a given query. If set to true, the API will continue deleting the next matching security-certificate even when the deletion of a previous security-certificate fails. If set to false, the API will return on the first failure. Default: false
> max-failure-count | [1..2^32-1] | integer optional | When allowing failures ('continue-on-failure' is set to true), then this input element may be provided to limit the number of failed deletions before the server gives up and returns. If set, the API will continue deleting the next matching security-certificate even when the deletion of a previous matching security-certificate fails, and do so until the total number of objects failed to be deleted reaches the maximum specified. If set to the maximum or not provided, then there will be no limit on the number of failed deletions. Only applicable if 'continue-on-failure' is set to true. Default: 2^32-1
> max-records | [1..2^32-1] | integer optional | The maximum number of security-certificate objects to delete in this call. Default: 20
> query |  | certificate-info | If deleting a specific security-certificate, this input element must specify all keys. If deleting multiple security-certificate objects based on query, this input element must specify a query.
> return-failure-list |  | boolean optional | If set to true, the API will return the list of security-certificate objects (just keys) that were not deleted due to some error. If set to false, the list of security-certificate objects not deleted will not be returned. Default: true
> return-success-list |  | boolean optional | If set to true, the API will return the list of security-certificate objects (just keys) that were successfully deleted. If set to false, the list of security-certificate objects deleted will not be returned. Default: true
> 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
> failure-list |  | security-certificate-delete-iter-info[] optional | Information about security-certificate objects that were not deleted due to some error. This element will be returned only if input element 'return-failure-list' is true.
> next-tag |  | string optional | Tag for the next call. Not present when there are no more matching security-certificate objects to be deleted.
> num-failed | [0..2^32-1] | integer optional | Number of security-certificate objects that matched the query, but were not deleted due to some error.
> num-succeeded | [0..2^32-1] | integer optional | The number of security-certificate objects that matched the query and were successfully deleted.
> success-list |  | security-certificate-delete-iter-info[] optional | The security-certificate objects that were successfully deleted. This element will be returned only if input element 'return-success-list' is true

> Errno | Description
> EINTERNALERROR |  |

security-certificate-generate-csr | [top]

> Generate a digital certificate signing request(CSR)

> Input Name | Range | Type | Description
> common-name |  | string | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
> country |  | string optional | Name of the country.
> email-address |  | string optional | Email address of administrator.
> hash-function |  | string optional | Hashing function used to sign the certificate. Default value is 'sha256'. Possible values: 'sha1' , 'sha256' , 'md5'
> locality |  | string optional | Name of the locality.
> organization |  | string optional | Name of the organization.
> organization-unit |  | string optional | Name of the unit. Example: IT, Finance.
> size |  | string optional | Size of requested certificate in bits. Default value is '2048'. Possible values: '512' - 512 bits private key, '1024' - 1024 bits private key, '1536' - 1536 bits private key, '2048' - 2048 bits private key
> state |  | string optional | Name of the state.
> Output Name | Range | Type | Description
> csr |  | string | Certificate Signing Request
> private-key |  | string | Private Key

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

security-certificate-get | [top]

> Get the attributes of the security-certificate.

> Input Name | Range | Type | Description
> certificate-authority |  | string | Certificate Authority
> common-name |  | string | Represents the domain name in FQDN form that specifies its exact location in the tree hierarchy of the Domain Name System (DNS).
> desired-attributes |  | certificate-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.
> serial-number |  | string optional | Serial number of certificate.
> type |  | string | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication
> Output Name | Range | Type | Description
> attributes |  | certificate-info | The attributes of the security-certificate.

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

security-certificate-get-iter | [top]

> Iterate over a list of security-certificate objects.

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

> Errno | Description
> EINTERNALERROR |  |

security-certificate-install | [top]

> Install a digital certificate

> Input Name | Range | Type | Description
> certificate |  | string | Public Key Certificate
> intermediate-cert-list |  | pubcertificate[] optional | Chain of Intermediate Certificates
> private-key |  | string optional | Private Key
> type |  | string | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication
> vserver |  | string optional | Name of vserver.

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

security-certificate-revoke | [top]

> Revoke a digital certificate

> Input Name | Range | Type | Description
> ca-serial-number |  | string | Serial number of CA certificate.
> certificate-authority |  | string | Certificate Authority
> 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).
> serial-number |  | string | Serial number of certificate.
> vserver |  | string optional | Name of vserver.

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

security-certificate-sign | [top]

> Sign a certificate using self-signed root CA

> Input Name | Range | Type | Description
> ca-serial-number |  | string | Serial number of CA certificate.
> certificate-authority |  | string | Certificate Authority to Sign
> csr |  | string | Certificate signing request.
> destination |  | uri optional | URI to send file to. Example: ftp://abc.com.
> expire-days |  | integer optional | Number of days until expiration. Default value is '365'.
> filepassword |  | string optional | Password for PKCS12 file
> format |  | string optional | Certificate Format. Default value is 'PEM'. Possible values: 'pkcs12' , 'pem'
> hash-function |  | string optional | Hashing function used to sign the certificate. Default value is 'sha256'. Possible values: 'sha1' , 'sha256' , 'md5'
> password |  | string optional | Destination URI password
> private-key |  | string optional | Private Key
> username |  | string optional | Destination URI username
> vserver |  | string optional | Name of vserver.
> Output Name | Range | Type | Description
> signed-cert |  | string | Signed certificate.

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

Element definition: certificate-ca-issued-info | [top]

> Information about issued digital certificates by Self-Signed Root CA 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
> ca-serial-number |  | string optional | Serial number of CA certificate. Attributes: key, non-creatable, non-modifiable
> certificate-authority |  | string optional | Certificate Authority Attributes: key, non-creatable, non-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). Attributes: non-creatable, non-modifiable
> country |  | string optional | Name of the country. Attributes: non-creatable, non-modifiable
> email-addr |  | string optional | Email address of administrator. Attributes: non-creatable, non-modifiable
> expiration-date | [0..2^31-1] | integer optional | Certificate expiration date. Attributes: non-creatable, non-modifiable
> locality |  | string optional | Name of the locality. Attributes: non-creatable, non-modifiable
> organization |  | string optional | Name of the organization. Attributes: non-creatable, non-modifiable
> organization-unit |  | string optional | Name of the unit. Example: IT, Finance. Attributes: non-creatable, non-modifiable
> revocation-date | [0..2^31-1] | integer optional | Certificate revocation date. Attributes: non-creatable, non-modifiable
> serial-number |  | string optional | Serial number of certificate. Attributes: key, non-creatable, non-modifiable
> state |  | string optional | Name of the state. Attributes: non-creatable, non-modifiable
> status |  | string optional | Status of certificate. Attributes: non-creatable, non-modifiable Possible values: "active" , "revoked"
> vserver |  | string optional | Name of vserver. Attributes: key, non-creatable, non-modifiable

Element definition: certificate-info | [top]

> Information about a Digital Certificate 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 | Certificate Authority Attributes: key, required-for-create, non-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). Attributes: key, required-for-create, non-modifiable
> country |  | string optional | Name of the country. Default value is 'US'. Attributes: required-for-create, non-modifiable
> email-address |  | string optional | Email address of administrator. Default value is empty string. Attributes: required-for-create, non-modifiable
> expiration-date | [0..2^31-1] | integer optional | Certificate Expiration Date Attributes: non-creatable, non-modifiable
> expire-days | [1..36510] | integer optional | Number of days until expiration. Default value is '365'. Attributes: required-for-create, non-modifiable
> hash-function |  | string optional | Hashing function used to sign the certificate. Default value is 'sha256'. Attributes: required-for-create, non-modifiable Possible values: "sha1" , "sha256" , "md5"
> locality |  | string optional | Name of the locality Default value is empty string. Attributes: required-for-create, non-modifiable
> organization |  | string optional | Name of the organization. Default value is empty string. Attributes: required-for-create, non-modifiable
> organization-unit |  | string optional | Name of the unit. Example: IT, Finance. Default value is empty string. Attributes: required-for-create, non-modifiable
> protocol |  | string optional | Protocol Attributes: non-creatable, non-modifiable Possible values: "ssl"
> public-certificate |  | string optional | Public Key Certificate Attributes: non-creatable, non-modifiable
> serial-number |  | string optional | Serial number of certificate. Attributes: key, required-for-create, non-modifiable
> size |  | string optional | Size of requested certificate in bits. Default value is '2048'. Attributes: required-for-create, non-modifiable Possible values: "512" - 512 bits private key, "1024" - 1024 bits private key, "1536" - 1536 bits private key, "2048" - 2048 bits private key
> start-date | [0..2^31-1] | integer optional | Certificate Start Date Attributes: non-creatable, non-modifiable
> state |  | string optional | Name of the state. Default value is empty string. Attributes: required-for-create, non-modifiable
> type |  | string optional | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Name of vserver. Attributes: key, non-creatable, non-modifiable

Element definition: pubcertificate | [top]

> [none]

Element definition: security-certificate-delete-iter-info | [top]

> Information about the deletion operation that was attempted/performed against security-certificate object.

> Name | Range | Type | Description
> error-code | [0..2^32-1] | integer optional | Error code, if the deletion operation caused an error.
> error-message |  | string optional | Error description, if the operation caused an error.
> security-certificate-key |  | certificate-info | The keys for the security-certificate object to which the deletion applies.

Element definition: uri | [top]

> [none]

Element definition: certificate-info | [top]

> Information about a Digital Certificate 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 | Certificate Authority Attributes: key, required-for-create, non-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). Attributes: key, required-for-create, non-modifiable
> country |  | string optional | Name of the country. Default value is 'US'. Attributes: required-for-create, non-modifiable
> email-address |  | string optional | Email address of administrator. Default value is empty string. Attributes: required-for-create, non-modifiable
> expiration-date | [0..2^31-1] | integer optional | Certificate Expiration Date Attributes: non-creatable, non-modifiable
> expire-days | [1..36510] | integer optional | Number of days until expiration. Default value is '365'. Attributes: required-for-create, non-modifiable
> hash-function |  | string optional | Hashing function used to sign the certificate. Default value is 'sha256'. Attributes: required-for-create, non-modifiable Possible values: "sha1" , "sha256" , "md5"
> locality |  | string optional | Name of the locality Default value is empty string. Attributes: required-for-create, non-modifiable
> organization |  | string optional | Name of the organization. Default value is empty string. Attributes: required-for-create, non-modifiable
> organization-unit |  | string optional | Name of the unit. Example: IT, Finance. Default value is empty string. Attributes: required-for-create, non-modifiable
> protocol |  | string optional | Protocol Attributes: non-creatable, non-modifiable Possible values: "ssl"
> public-certificate |  | string optional | Public Key Certificate Attributes: non-creatable, non-modifiable
> serial-number |  | string optional | Serial number of certificate. Attributes: key, required-for-create, non-modifiable
> size |  | string optional | Size of requested certificate in bits. Default value is '2048'. Attributes: required-for-create, non-modifiable Possible values: "512" - 512 bits private key, "1024" - 1024 bits private key, "1536" - 1536 bits private key, "2048" - 2048 bits private key
> start-date | [0..2^31-1] | integer optional | Certificate Start Date Attributes: non-creatable, non-modifiable
> state |  | string optional | Name of the state. Default value is empty string. Attributes: required-for-create, non-modifiable
> type |  | string optional | Type of certificate. Possible values: 'server' - Server certificate, 'root_ca' - Self-Signed Root CA, 'client_ca' - CA who signed user certificates', 'server_chain' - Intermediate certificate for server authentication Attributes: key, required-for-create, non-modifiable
> vserver |  | string optional | Name of vserver. Attributes: key, non-creatable, non-modifiable