ns_ssl_csr¶
Configuration for CSR File resource.
(click to see Operations)
Properties¶
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| tenant_name | <String> | Read-write | Tenant Name. |
| commonname | <String> | Read-write | Common Name. Minimum length = 1 |
| statename | <String> | Read-write | State Name. Minimum length = 2 Maximum length = 128 |
| organizationname | <String> | Read-write | Organization Name. Minimum length = 1 |
| keyform | <String> | Read-write | Key Form. |
| file_location_path | <String> | Read-write | File Location on Client for download. Minimum length = 1 |
| city | <String> | Read-write | City. |
| file_name | <String> | Read-write | Name for and, optionally, path to the certificate signing request (CSR). Minimum length = 1 Maximum length = 256 |
| countryname | <String> | Read-write | Country Name. Minimum length = 2 Maximum length = 128 |
| csr | <String> | Read-write | Generated CSR. |
| keyfile | <String> | Read-write | Key File. Minimum length = 1 Maximum length = 128 |
| passphrase | <String> | Read-write | Pass Phrase used to encrypt the private-key. |
| file_size | <Integer> | Read-only | file_size. |
| file_last_modified | <String> | Read-only | Last Modified. |
Operations¶
(click to see Properties)
ADD| DELETE| GET (ALL)| GET| UPLOAD| DOWNLOAD
Some options that you can use for each operations:
Getting warnings in response:NITRO allows you to get warnings in an operation by specifying the "warning" query parameter as "yes". For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
http://<netscaler-ip-address>/nitro/v1/config/login?warning=yes
If any, the warnings are displayed in the response payload with the HTTP code "209 X-NITRO-WARNING".
Authenticated access for individual NITRO operations:NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
To do this, you must specify the username and password in the request header of the NITRO request as follows:
X-NITRO-USER:<username>
X-NITRO-PASS:<password>
Note: In such cases, make sure that the request header DOES not include the following:
Cookie:NITRO_AUTH_TOKEN=<tokenvalue>
Note:
Mandatory parameters are marked in red and placeholder content is marked in <green>.
add¶
URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_csr?onerror=<String_value>
HTTP Method: null
Request Payload:
{ns_ssl_csr: {
<b>"commonname":<String_value></b>,
<b>"statename":<String_value></b>,
<b>"organizationname":<String_value></b>,
<b>"file_name":<String_value></b>,
<b>"countryname":<String_value></b>,
<b>"keyfile":<String_value></b>,
"keyform":<String_value>,
"city":<String_value>,
"passphrase":<String_value>,
"tenant_name":<String_value>,
"file_location_path":<String_value>,
"csr":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_csr":[{ "tenant_name":<String_value>, "commonname":<String_value>, "statename":<String_value>, "file_size":<Integer_value>, "organizationname":<String_value>, "file_last_modified":<String_value>, "keyform":<String_value>, "is_dir":<Boolean_value>, "file_location_path":<String_value>, "city":<String_value>, "file_name":<String_value>, "countryname":<String_value>, "csr":<String_value>, "keyfile":<String_value>, "passphrase":<String_value>}]}
delete¶
URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_csr/file_name_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value> }
get (all)¶
URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_csr
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_csr":[{ "tenant_name":<String_value>, "commonname":<String_value>, "statename":<String_value>, "file_size":<Integer_value>, "organizationname":<String_value>, "file_last_modified":<String_value>, "keyform":<String_value>, "is_dir":<Boolean_value>, "file_location_path":<String_value>, "city":<String_value>, "file_name":<String_value>, "countryname":<String_value>, "csr":<String_value>, "keyfile":<String_value>, "passphrase":<String_value>}]}
get¶
URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_csr/file_name_value<String>
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_csr":[{ "tenant_name":<String_value>, "commonname":<String_value>, "statename":<String_value>, "file_size":<Integer_value>, "organizationname":<String_value>, "file_last_modified":<String_value>, "keyform":<String_value>, "is_dir":<Boolean_value>, "file_location_path":<String_value>, "city":<String_value>, "file_name":<String_value>, "countryname":<String_value>, "csr":<String_value>, "keyfile":<String_value>, "passphrase":<String_value>}]}
upload¶
URL: https://<MGMT-IP>/nitro/v1/upload/ns_ssl_csr
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done }
download¶
URL: https://<MGMT-IP>/nitro/v1/download/ns_ssl_csr/file_name_value<String>
HTTP Method: null