Skip to content

vpnurlpolicy_binding

Binding object which returns the resources bound to vpnurlpolicy.

Properties

(click to see Operations )

Name Data Type Permissions Description
name <String> Read-write Name for the new urlPolicy.

Minimum length = 1
vpnurlpolicy_aaauser_binding <vpnurlpolicy_aaauser_binding[]> Read-only aaauser that can be bound to vpnurlpolicy.
vpnurlpolicy_vpnglobal_binding <vpnurlpolicy_vpnglobal_binding[]> Read-only vpnglobal that can be bound to vpnurlpolicy.
vpnurlpolicy_vpnvserver_binding <vpnurlpolicy_vpnvserver_binding[]> Read-only vpnvserver that can be bound to vpnurlpolicy.
vpnurlpolicy_aaagroup_binding <vpnurlpolicy_aaagroup_binding[]> Read-only aaagroup that can be bound to vpnurlpolicy.

Operations

(click to see Properties )

  • GET
  • GET (ALL)

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

get

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

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:

{ "vpnurlpolicy_binding": [ {
      "name":<String_value>,
      "vpnurlpolicy_vpnglobal_binding":<vpnurlpolicy_vpnglobal_binding[]_value>,
      "vpnurlpolicy_vpnvserver_binding":<vpnurlpolicy_vpnvserver_binding[]_value>,
      "vpnurlpolicy_aaauser_binding":<vpnurlpolicy_aaauser_binding[]_value>,
      "vpnurlpolicy_aaagroup_binding":<vpnurlpolicy_aaagroup_binding[]_value>
}]}

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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

NITRO allows you to fetch bindings in bulk.

Note: get (all) method can be used only in conjuction with bulkbindings query parameter.

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:

{ "vpnurlpolicy_binding": [ {
      "name":<String_value>,
      "vpnurlpolicy_vpnglobal_binding":<vpnurlpolicy_vpnglobal_binding[]_value>,
      "vpnurlpolicy_vpnvserver_binding":<vpnurlpolicy_vpnvserver_binding[]_value>,
      "vpnurlpolicy_aaauser_binding":<vpnurlpolicy_aaauser_binding[]_value>,
      "vpnurlpolicy_aaagroup_binding":<vpnurlpolicy_aaagroup_binding[]_value>
}]}