Download full document:

aaagroup_tmsessionpolicy_binding

Binding object showing the tmsessionpolicy that can be bound to aaagroup.

Properties

(click to see Operations)

NameData TypePermissionsDescription
priority<Double>Read-writeInteger specifying the priority of the policy. A lower number indicates a higher priority. Policies are evaluated in the order of their priority numbers. Maximum value for default syntax policies is 2147483647 and for classic policies is 64000.
Minimum value = 0
Maximum value = 2147483647
gotopriorityexpression<String>Read-writeExpression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.
policy<String>Read-writeThe policy name.
type<String>Read-writeBindpoint to which the policy is bound.
Default value: REQUEST
Possible values = REQUEST, UDP_REQUEST, DNS_REQUEST, ICMP_REQUEST
groupname<String>Read-writeName of the group that you are binding.
Minimum length = 1
acttype<Double>Read-only.
__count<Double>Read-onlycount parameter

Operations

(click to see Properties)

ADD:| DELETE:| GET| GET (ALL)| 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 redand placeholder content is marked in <green>.

add:

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

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{
"aaagroup_tmsessionpolicy_binding":{
<b>"groupname":<String_value>,
</b>"policy":<String_value>,
"priority":<Double_value>,
"type":<String_value>,
"gotopriorityexpression":<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/aaagroup_tmsessionpolicy_binding/groupname_value<String>

Query-parameters:

args

http://<netscaler-ip-address>/nitro/v1/config/aaagroup_tmsessionpolicy_binding/groupname_value<String>?args=policy:<String_value>,type:<String_value>

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

URL:http://<netscaler-ip-address>/nitro/v1/config/aaagroup_tmsessionpolicy_binding/groupname_value<String>

Query-parameters:

filter

http://<netscaler-ip-address>/nitro/v1/config/aaagroup_tmsessionpolicy_binding/groupname_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagination

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

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

Content-Type:application/json

Response Payload:

{ "aaagroup_tmsessionpolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policy":<String_value>,
"type":<String_value>,
"groupname":<String_value>,
"acttype":<Double_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/aaagroup_tmsessionpolicy_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "aaagroup_tmsessionpolicy_binding": [ {
"priority":<Double_value>,
"gotopriorityexpression":<String_value>,
"policy":<String_value>,
"type":<String_value>,
"groupname":<String_value>,
"acttype":<Double_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/aaagroup_tmsessionpolicy_binding/groupname_value<String>?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 errorResponse Headers:

Content-Type:application/json

Response Payload:

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