ADC NITRO APIs

forwardingsession

August 17, 2023

Contributed by:

Configuration for session forward resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the forwarding session rule. Can begin with a letter, number, or the underscore character (_), and can consist of letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@), equals (=), colon (:), and underscore characters. Cannot be changed after the rule is created. The following requirement applies only to the Citrix ADC CLI If the name includes one or more spaces, enclose the name in double or single quotation marks (for example, “my rule” or ‘my rule’). Minimum length = 1
network	Read-write	An IPv4 network address or IPv6 prefix of a network from which the forwarded traffic originates or to which it is destined. Minimum length = 1
netmask	Read-write	Subnet mask associated with the network. Minimum length = 1
acl6name	Read-write	Name of any configured ACL6 whose action is ALLOW. The rule of the ACL6 is used as a forwarding session rule. Minimum length = 1
aclname	Read-write	Name of any configured ACL whose action is ALLOW. The rule of the ACL is used as a forwarding session rule. Minimum length = 1
td	Read-write	Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value = 0 Maximum value = 4094
connfailover	Read-write	Synchronize connection information with the secondary appliance in a high availability (HA) pair. That is, synchronize all connection-related information for the forwarding session. Default value: DISABLED Possible values = ENABLED, DISABLED
sourceroutecache	Read-write	Cache the source ip address and mac address of the DA servers. Default value: DISABLED Possible values = ENABLED, DISABLED
processlocal	Read-write	Enabling this option on forwarding session will not steer the packet to flow processor. Instead, packet will be routed. Default value: DISABLED Possible values = ENABLED, DISABLED
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
UPDATE
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:// <netscaler-ip-address> /nitro/v1/config/forwardingsession

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"forwardingsession":{
<b>      "name":<String_value>,
</b>      "network":<String_value>,
      "netmask":<String_value>,
      "acl6name":<String_value>,
      "aclname":<String_value>,
      "td":<Double_value>,
      "connfailover":<String_value>,
      "sourceroutecache":<String_value>,
      "processlocal":<String_value>
}}

<!--NeedCopy-->

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

update

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

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"forwardingsession":{
<b>      "name":<String_value>,
</b>      "connfailover":<String_value>,
      "sourceroutecache":<String_value>,
      "processlocal":<String_value>,
      "acl6name":<String_value>,
      "aclname":<String_value>
}}

<!--NeedCopy-->

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/forwardingsession/ name_value<String>

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

get (all)

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

Query-parameters:

attrs

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

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

view

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

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

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

{ "forwardingsession": [ {
      "name":<String_value>,
      "network":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "aclname":<String_value>,
      "acl6name":<String_value>,
      "connfailover":<String_value>,
      "sourceroutecache":<String_value>,
      "processlocal":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/forwardingsession/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/forwardingsession/ name_value<String> ? 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/forwardingsession/ name_value<String> ? view=summary

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

{  "forwardingsession": [ {
      "name":<String_value>,
      "network":<String_value>,
      "netmask":<String_value>,
      "td":<Double_value>,
      "aclname":<String_value>,
      "acl6name":<String_value>,
      "connfailover":<String_value>,
      "sourceroutecache":<String_value>,
      "processlocal":<String_value>
}]}

<!--NeedCopy-->

count

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

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

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

forwardingsession

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

forwardingsession

Properties

Operations

add

update

delete

get (all)

get

count

In this article