Product Documentation

vpnglobal_vpnsessionpolicy_binding

Sep 08, 2016

Binding object showing the vpnsessionpolicy that can be bound to vpnglobal.

Properties (click to see Operations)

Name Data Type Permissions Description
priority
<Double>
Read-write
The priority of the policy.
builtin
<String[]>
Read-write
Indicates that a variable is a built-in (SYSTEM INTERNAL) type.
Possible values = MODIFIABLE, DELETABLE, IMMUTABLE, PARTITION_ALL
policyname
<String>
Read-write
The name of the policy.
secondary
<Boolean>
Read-write
Bind the authentication policy as the secondary policy to use in a two-factor configuration. A user must then authenticate not only to a primary authentication server but also to a secondary authentication server. User groups are aggregated across both authentication servers. The user name must be exactly the same on both authentication servers, but the authentication servers can require different passwords.
groupextraction
<Boolean>
Read-write
Bind the Authentication policy to a tertiary chain which will be used only for group extraction. The user will not authenticate against this server, and this will only be called it primary and/or secondary authentication has succeeded.
__count
<Double>
Read-write
count parameter

Operations (click to see Properties)

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>

메모

Mandatory parameters are marked in red and placeholder content is marked in <green>.

add:

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

HTTP Method: PUT

Request Headers:

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

Request Payload:

{
"vpnglobal_vpnsessionpolicy_binding":{
      "policyname":<String_value>,
      "priority":<Double_value>,
      "secondary":<Boolean_value>,
      "groupextraction":<Boolean_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/vpnglobal_vpnsessionpolicy_binding

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

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of vpnglobal_vpnsessionpolicy_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/vpnglobal_vpnsessionpolicy_binding?pagesize=#no&pageno=#no

Use this query-parameter to get the vpnglobal_vpnsessionpolicy_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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "vpnglobal_vpnsessionpolicy_binding": [ {
      "priority":<Double_value>,
      "builtin":<String[]_value>,
      "policyname":<String_value>,
      "secondary":<Boolean_value>,
      "groupextraction":<Boolean_value>
}]}

get (all)

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

Query-parameters:

bulkbindings

http://<netscaler-ip-address>/nitro/v1/config/vpnglobal_vpnsessionpolicy_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 error

Response Headers:

Content-Type:application/json

Response Payload:

{ "vpnglobal_vpnsessionpolicy_binding": [ {
      "priority":<Double_value>,
      "builtin":<String[]_value>,
      "policyname":<String_value>,
      "secondary":<Boolean_value>,
      "groupextraction":<Boolean_value>
}]}

count

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

Content-Type:application/json

Response Payload:

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