Download full document:

vpnvserver_authenticationldappolicy_binding

Binding object showing the authenticationldappolicy that can be bound to vpnvserver.

Properties

(click to see Operations)

Name	Data Type	Permissions	Description
priority	<Double>	Read-write	The priority, if any, of the VPN virtual server policy.
gotopriorityexpression	<String>	Read-write	Expression or other value specifying the next policy to evaluate if the current policy evaluates to TRUE. Specify one of the following values: * NEXT - Evaluate the policy with the next higher priority number. * END - End policy evaluation. * USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label. If the final goto in the invoked policy label has a value of END, the evaluation stops. If the final goto is anything other than END, the current policy label performs a NEXT. * A default syntax or classic expression that evaluates to a number. If you specify an expression, the number to which it evaluates determines the next policy to evaluate, as follows: * If the expression evaluates to a higher numbered priority, the policy with that priority is evaluated next. * If the expression evaluates to the priority of the current policy, the policy with the next higher numbered priority is evaluated next. * If the expression evaluates to a number that is larger than the largest numbered priority, policy evaluation ends. An UNDEF event is triggered if: * The expression is invalid. * The expression evaluates to a priority number that is numerically lower than the current policys priority. * The expression evaluates to a priority number that is between the current policys priority number (say, 30) and the highest priority number (say, 100), but does not match any configured priority number (for example, the expression evaluates to the number 85). This example assumes that the priority number increments by 10 for every successive policy, and therefore a priority number of 85 does not exist in the policy label.
policy	<String>	Read-write	The name of the policy, if any, bound to the VPN virtual server.
groupextraction	<Boolean>	Read-write	Binds 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 if primary and/or secondary authentication has succeeded.
name	<String>	Read-write	Name of the virtual server.<br>Minimum length = 1
secondary	<Boolean>	Read-write	Binds the authentication policy as the secondary policy to use in a two-factor configuration. A user must then authenticate not only via a primary authentication method but also via a secondary authentication method. User groups are aggregated across both. The user name must be exactly the same for both authentication methods, but they can require different passwords.
bindpoint	<String>	Read-write	Bind point to which to bind the policy. Applies only to rewrite and cache policies. If you do not set this parameter, the policy is bound to REQ_DEFAULT or RES_DEFAULT, depending on whether the policy rule is a response-time or a request-time expression.<br>Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST
acttype	<Double>	Read-only	.
__count	<Double>	Read-only	count parameter

Operations

(click to see Properties)

ADD: | DELETE: | 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://NS_IP/nitro/v1/config

HTTP Method: PUT

Request Payload:

{
"params":{
      "warning":<String_value>,
      "onerror":<String_value>
},
sessionid":"##sessionid","vpnvserver_authenticationldappolicy_binding":{
      "name":<String_value>,
      "policy":<String_value>,
                  "priority":<Double_value>,
                  "secondary":<Boolean_value>,
                  "groupextraction":<Boolean_value>,
                  "gotopriorityexpression":<String_value>,
                  "bindpoint":<String_value>,

}}

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

delete:

URL: http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: DELETE

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": }

get

URL: http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>

Query-parameters:

filter

http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>?filter=property-name1:property-value1,property-name2:property-value2

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

pagesize=#no;pageno=#no

http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding?warning=yes

Use this query parameter to get warnings in nitro response. If this field is set to YES, warning message will be sent in 'message' field and 'WARNING' value is set in severity field of the response in case there is a

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": <String_value>, "vpnvserver_authenticationldappolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policy":<String_value>,
      "groupextraction":<Boolean_value>,
      "name":<String_value>,
      "secondary":<Boolean_value>,
      "bindpoint":<String_value>,
      "acttype":<Double_value>,

}]}

count

URL: http://<NS_IP>/nitro/v1/config/vpnvserver_authenticationldappolicy_binding/name_value<String>?count=yes

HTTP Method: GET

Response Payload:

{ "errorcode": 0, "message": "Done",vpnvserver_authenticationldappolicy_binding: [ { "__count": "#no"} ] }