nstrafficdomain¶

Configuration for Traffic Domain resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
td	<Double>	Read-write	Integer value that uniquely identifies a traffic domain. Minimum value = 1 Maximum value = 4094
aliasname	<String>	Read-write	Name of traffic domain being added. Minimum length = 1 Maximum length = 31
vmac	<String>	Read-write	Associate the traffic domain with a VMAC address instead of with VLANs. The Citrix ADC then sends the VMAC address of the traffic domain in all responses to ARP queries for network entities in that domain. As a result, the ADC can segregate subsequent incoming traffic for this traffic domain on the basis of the destination MAC address, because the destination MAC address is the VMAC address of the traffic domain. After creating entities on a traffic domain, you can easily manage and monitor them by performing traffic domain level operations. Default value: DISABLED Possible values = ENABLED, DISABLED
state	<String>	Read-only	The state of TrafficDmain. Default value: ENABLED Possible values = ENABLED, DISABLED
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

ADD
DELETE
CLEAR
ENABLE
DISABLE
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:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nstrafficdomain":{
<b>      "td":<Double_value>,
</b>      "aliasname":<String_value>,
      "vmac":<String_value>
}}

Response:

HTTP Status Code on Success: 201 Created

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

delete¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain/ td_value<Double>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

clear¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nstrafficdomain":{
<b>      "td":<Double_value>
</b>}}

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

enable¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nstrafficdomain":{
<b>      "td":<Double_value>
</b>}}

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

disable¶

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

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"nstrafficdomain":{
<b>      "td":<Double_value>
</b>}}

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/nstrafficdomain

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain? 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/nstrafficdomain? filter=property-name1:property-val1,property-name2:property-val2

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

view

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

Use this query-parameter to get the summary output of nstrafficdomain 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/nstrafficdomain? pagesize=#no;pageno=#no

Use this query-parameter to get the nstrafficdomain 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:

{ "nstrafficdomain": [ {
      "td":<Double_value>,
      "aliasname":<String_value>,
      "vmac":<String_value>,
      "state":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain/ td_value<Double>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain/ td_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/nstrafficdomain/ td_value<Double> ? view=summary

Use this query-parameter to get the summary output of nstrafficdomain 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:

{  "nstrafficdomain": [ {
      "td":<Double_value>,
      "aliasname":<String_value>,
      "vmac":<String_value>,
      "state":<String_value>
}]}

count¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/nstrafficdomain? 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:

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