Download full document:

vpnvserver_appflowpolicy_binding

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

Properties

(click to see Operations)

Name Data Type PermissionsDescription
priority<Double>Read-writeThe priority, if any, of the VPN virtual server policy.
gotopriorityexpression<String>Read-writeNext priority expression.
policy<String>Read-writeThe name of the policy, if any, bound to the VPN virtual server.
groupextraction<Boolean>Read-writeBinds 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-writeName of the virtual server.<br>Minimum length = 1
secondary<Boolean>Read-writeBinds 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-writeBindpoint to which the policy is bound.<br>Possible values = REQUEST, RESPONSE, ICA_REQUEST, OTHERTCP_REQUEST
__count<Double>Read-writecount 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_appflowpolicy_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_appflowpolicy_binding/name_value<String>

Query-parameters:

warning

http://<NS_IP>/nitro/v1/config/vpnvserver_appflowpolicy_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_appflowpolicy_binding/name_value<String>

Query-parameters:

filter

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

Use this query-parameter to get the filtered set of vpnvserver_appflowpolicy_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_appflowpolicy_binding/name_value<String>?pagesize=#no;pageno=#no

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

warning

http://<NS_IP>/nitro/v1/config/vpnvserver_appflowpolicy_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_appflowpolicy_binding": [ {
      "priority":<Double_value>,
      "gotopriorityexpression":<String_value>,
      "policy":<String_value>,
      "groupextraction":<Boolean_value>,
      "name":<String_value>,
      "secondary":<Boolean_value>,
      "bindpoint":<String_value>,

}]}

count

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

HTTP Method: GET

Response Payload:

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