nsdiameter¶

Configuration for Diameter Parameters resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
identity	<String>	Read-write	DiameterIdentity to be used by NS. DiameterIdentity is used to identify a Diameter node uniquely. Before setting up diameter configuration, Citrix ADC (as a Diameter node) MUST be assigned a unique DiameterIdentity. example => set ns diameter -identity netscaler.com Now whenever Citrix ADC needs to use identity in diameter messages. It will use 'netscaler.com' as Origin-Host AVP as defined in RFC3588 . Minimum length = 1
realm	<String>	Read-write	Diameter Realm to be used by NS. example => set ns diameter -realm com Now whenever Citrix ADC system needs to use realm in diameter messages. It will use 'com' as Origin-Realm AVP as defined in RFC3588 . Minimum length = 1
serverclosepropagation	<String>	Read-write	when a Server connection goes down, whether to close the corresponding client connection if there were requests pending on the server. Default value: NO Possible values = YES, NO
ownernode	<Double>	Read-write	ID of the cluster node for which the diameter id is set, can be configured only through CLIP. Default value: -1 Minimum value = 0 Maximum value = 31
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

UPDATE
UNSET
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

update¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsdiameter":{
      "identity":<String_value>,
      "realm":<String_value>,
      "serverclosepropagation":<String_value>,
      "ownernode":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nsdiameter":{
      "serverclosepropagation":true,
      "ownernode":<Double_value>
}}

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

get (all)¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? filter=property-name1:property-val1,property-name2:property-val2

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

view

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? view=summary

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

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? pagesize=#no;pageno=#no

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nsdiameter": [ {
      "ownernode":<Double_value>,
      "identity":<String_value>,
      "realm":<String_value>,
      "serverclosepropagation":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter/ ownernode_value<Double>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter/ ownernode_value<Double> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter/ ownernode_value<Double> ? view=summary

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

Note: By default, the retrieved results are displayed in detail view (?view=detail).

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{  "nsdiameter": [ {
      "ownernode":<Double_value>,
      "identity":<String_value>,
      "realm":<String_value>,
      "serverclosepropagation":<String_value>
}]}

count¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nsdiameter? count=yes

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:

{ "nsdiameter": [ { "__count": "#no"} ] }