Skip to content

ns_ssl_certkey_policy

Configuration for NetScaler SSL Cert-Key Polling Policy resource.

(click to see Operations)

Properties

(click to see Operations)

NameData TypePermissionsDescription
interval_unit<String>Read-writeThis property is deprecated, polling interval will be provided in minutes only;ltbr;gtFrequency unit (Minutes).
polling_interval<Integer>Read-writeFrequency of polling in minutes.
Minimum value = 30
Maximum value =
ns_ip_address<String[]>Read-writeList of NetScaler IP Address.
Minimum length = 1
Maximum length = 64
act_id<String>Read-writeActivity ID that is used by GUI to track the polling status..

Operations

(click to see Properties)

DO_POLL| GET| UPDATE

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>.

do_poll

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_certkey_policy?action=do_poll;onerror=<String_value>

HTTP Method: null

Request Payload:

{ns_ssl_certkey_policy: {
<b>"polling_interval":<Integer_value></b>,
"ns_ip_address":<String_value[]>,
"act_id":<String_value>,
"interval_unit":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_certkey_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_certkey_policy

HTTP Method: null

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_certkey_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v1/config/ns_ssl_certkey_policy/

HTTP Method: null

Request Payload:

{ns_ssl_certkey_policy:{
<b>"polling_interval":<Integer_value></b>,
"ns_ip_address":<String_value[]>,
"act_id":<String_value>,
"interval_unit":<String_value>}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value>, "ns_ssl_certkey_policy":[{
"interval_unit":<String_value>,
"polling_interval":<Integer_value>,
"ns_ip_address":<String_value>,
"act_id":<String_value>}]}