Skip to content
Was this article helpful?

dnskey

Configuration for 0 resource.

Properties

(click to see Operations)

Name Data Type PermissionsDescription
keyname<String>Read-writeName of the public-private key pair to publish in the zone.<br>Minimum length = 1
publickey<String>Read-writeFile name of the public key.
privatekey<String>Read-writeFile name of the private key.
expires<Double>Read-writeTime period for which to consider the key valid, after the key is used to sign a zone.<br>Default value: 120<br>Minimum value = 1<br>Maximum value = 32767
units1<String>Read-writeUnits for the expiry period.<br>Default value: DAYS<br>Possible values = MINUTES, HOURS, DAYS
notificationperiod<Double>Read-writeTime at which to generate notification of key expiration, specified as number of days, hours, or minutes before expiry. Must be less than the expiry period. The notification is an SNMP trap sent to an SNMP manager. To enable the appliance to send the trap, enable the DNSKEY-EXPIRY SNMP alarm.<br>Default value: 7<br>Minimum value = 1<br>Maximum value = 32767
units2<String>Read-writeUnits for the notification period.<br>Default value: DAYS<br>Possible values = MINUTES, HOURS, DAYS
ttl<Double>Read-writeTime to Live (TTL), in seconds, for the DNSKEY resource record created in the zone. TTL is the time for which the record must be cached by the DNS proxies. If the TTL is not specified, either the DNS zones minimum TTL or the default value of 3600 is used.<br>Default value: 3600<br>Minimum value = 0<br>Maximum value = 2147483647
zonename<String>Read-writeName of the zone for which to create a key.<br>Minimum length = 1
keytype<String>Read-writeType of key to create.<br>Default value: NS_DNSKEY_ZSK<br>Possible values = KSK, KeySigningKey, ZSK, ZoneSigningKey
algorithm<String>Read-writeAlgorithm to generate for zone signing.<br>Default value: NS_DNSKEYALGO_RSASHA1<br>Possible values = RSASHA1
keysize<Double>Read-writeSize of the key, in bits.<br>Default value: 512
filenameprefix<String>Read-writeCommon prefix for the names of the generated public and private key files and the Delegation Signer (DS) resource record. During key generation, the .key, .private, and .ds suffixes are appended automatically to the file name prefix to produce the names of the public key, the private key, and the DS record, respectively.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD | CREATE | UPDATE | UNSET | DELETE | GET (ALL) | GET | COUNT

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: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
"sessionid":"##sessionid",
"dnskey":{
      "keyname":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "expires":<Double_value>,
                  "units1":<String_value>,
      "notificationperiod":<Double_value>,
                  "units2":<String_value>,
      "ttl":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

create

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"create"
},
"sessionid":"##sessionid",
"dnskey":{
      "zonename":<String_value>,
      "keytype":<String_value>,
      "algorithm":<String_value>,
      "keysize":<Double_value>,
      "filenameprefix":<String_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

update

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: PUT

Request Payload: 

{
"params": {
      "warning":<String_value>,
      "onerror":<String_value>"
},
sessionid":"##sessionid",
"dnskey":{
      "keyname":<String_value>,
      "expires":<Double_value>,
                  "units1":<String_value>,
      "notificationperiod":<Double_value>,
                  "units2":<String_value>,
      "ttl":<Double_value>,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

unset

URL: http://<NSIP>/nitro/v1/config/

HTTP Method: POST

Request Payload: 

object={
"params":{
      "warning":<String_value>,
      "onerror":<String_value>,
      "action":"unset"
},
"sessionid":"##sessionid",
"dnskey":{
      "keyname":<String_value>,
      "expires":true,
      "units1":true,
      "notificationperiod":true,
      "units2":true,
      "ttl":true,
}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete

URL: http://<NSIP>/nitro/v1/config/dnskey/keyname_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/dnskey/keyname_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get (all)

URL: http://<NSIP>/nitro/v1/config/dnskey

Query-parameters:

filter

http://<NSIP>/nitro/v1/config/dnskey?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of dnskey resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<NS_IP>/nitro/v1/config/dnskey?view=summary

Use this query-parameter to get the summary output of dnskey resources configured on NetScaler.

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/dnskey?pagesize=#no;pageno=#no

Use this query-parameter to get the dnskey resources in chunks.

warning

http://<NS_IP>/nitro/v1/config/dnskey?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "dnskey": [ {
      "keyname":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "expires":<Double_value>,
      "units1":<String_value>,
      "notificationperiod":<Double_value>,
      "units2":<String_value>,
      "ttl":<Double_value>,
      "zonename":<String_value>

}]}

get

URL: http://<NS_IP>/nitro/v1/config/dnskey/keyname_value<String>

HTTP Method: GET

Response Payload: 

{ "errorcode": 0, "message": "Done", "dnskey": [ {
      "keyname":<String_value>,
      "publickey":<String_value>,
      "privatekey":<String_value>,
      "expires":<Double_value>,
      "units1":<String_value>,
      "notificationperiod":<Double_value>,
      "units2":<String_value>,
      "ttl":<Double_value>,
      "zonename":<String_value>

}]}

count

URL: http://<NS_IP>/nitro/v1/config/dnskey?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",dnskey: [ { "__count": "#no"} ] }

Was this article helpful?