mps_ssl_certkey
Configuration for Install SSL certificate on Management Service resource.
(click to see Operations)
Properties
(click to see Operations)
| Name | Data Type | Permissions | Description |
|---|---|---|---|
| password | <String> | Read-write | The pass-phrase that was used to encrypt the private-key.. Maximum length = 32 |
| ssl_key | <String> | Read-write | Key. Minimum length = 1 Maximum length = 128 |
| ssl_certificate | <String> | Read-write | Certificate. Minimum length = 1 Maximum length = 128 |
| fingerprint | <String> | Read-write | SHA-1 Fingerprint of MAS SSL Certificate. Minimum length = 1 Maximum length = 512 |
| serial_number | <String> | Read-only | Serial Number. |
| signature_algorithm | <String> | Read-only | Signature Algorithm. |
| valid_from | <String> | Read-only | Valid From. |
| status | <String> | Read-only | Tells whether the certificate is still valid or not. |
| issuer | <String> | Read-only | Issuer. |
| public_key_size | <Integer> | Read-only | Public Key Size. |
| valid_to | <String> | Read-only | Valid To. |
| version | <String> | Read-only | Version. |
| subject | <String> | Read-only | Subject. |
| public_key_algorithm | <String> | Read-only | Public Key Algorithm. |
| days_to_expiry | <Integer> | Read-only | Days before SSL certificate expires. |
Operations
(click to see Properties)
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/mps_ssl_certkey?onerror=<String_value>
HTTP Method: null
Request Payload:
{mps_ssl_certkey: {
<b>"ssl_certificate":<String_value></b>,
"fingerprint":<String_value>,
"password":<String_value>,
"ssl_key":<String_value>}}
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"issuer":<String_value>,
"public_key_size":<Integer_value>,
"password":<String_value>,
"ssl_key":<String_value>,
"valid_to":<String_value>,
"reboot":<Boolean_value>,
"version":<String_value>,
"subject":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"ssl_certificate":<String_value>,
"cert_format":<String_value>,
"fingerprint":<String_value>}]}
get (all)
URL: https://<MGMT-IP>/nitro/v1/config/mps_ssl_certkey
HTTP Method: null
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "mps_ssl_certkey":[{
"serial_number":<String_value>,
"signature_algorithm":<String_value>,
"valid_from":<String_value>,
"status":<String_value>,
"issuer":<String_value>,
"public_key_size":<Integer_value>,
"password":<String_value>,
"ssl_key":<String_value>,
"valid_to":<String_value>,
"reboot":<Boolean_value>,
"version":<String_value>,
"subject":<String_value>,
"public_key_algorithm":<String_value>,
"days_to_expiry":<Integer_value>,
"ssl_certificate":<String_value>,
"cert_format":<String_value>,
"fingerprint":<String_value>}]}