Developer Documentation
ADC NITRO APIs
Current Release 13.1 13

vpnvserver_binding

August 17, 2023
Contributed by: 
C

Binding object which returns the resources bound to vpnvserver.

Properties

(click to see Operations )

Name Data Type Permissions Description
name Read-write Name of the Citrix Gateway virtual server for which to show detailed information.

Minimum length = 1
vpnvserver_intranetip6_binding <vpnvserver_intranetip6_binding[]> Read-only intranetip6 that can be bound to vpnvserver.
vpnvserver_authenticationradiuspolicy_binding <vpnvserver_authenticationradiuspolicy_binding[]> Read-only authenticationradiuspolicy that can be bound to vpnvserver.
vpnvserver_vpnsessionpolicy_binding <vpnvserver_vpnsessionpolicy_binding[]> Read-only vpnsessionpolicy that can be bound to vpnvserver.
vpnvserver_vpnurlpolicy_binding <vpnvserver_vpnurlpolicy_binding[]> Read-only vpnurlpolicy that can be bound to vpnvserver.
vpnvserver_vpnnexthopserver_binding <vpnvserver_vpnnexthopserver_binding[]> Read-only vpnnexthopserver that can be bound to vpnvserver.
vpnvserver_authenticationldappolicy_binding <vpnvserver_authenticationldappolicy_binding[]> Read-only authenticationldappolicy that can be bound to vpnvserver.
vpnvserver_authenticationsamlidppolicy_binding <vpnvserver_authenticationsamlidppolicy_binding[]> Read-only authenticationsamlidppolicy that can be bound to vpnvserver.
vpnvserver_authenticationwebauthpolicy_binding <vpnvserver_authenticationwebauthpolicy_binding[]> Read-only authenticationwebauthpolicy that can be bound to vpnvserver.
vpnvserver_sharefileserver_binding <vpnvserver_sharefileserver_binding[]> Read-only sharefileserver that can be bound to vpnvserver.
vpnvserver_authenticationlocalpolicy_binding <vpnvserver_authenticationlocalpolicy_binding[]> Read-only authenticationlocalpolicy that can be bound to vpnvserver.
vpnvserver_vpnintranetapplication_binding <vpnvserver_vpnintranetapplication_binding[]> Read-only vpnintranetapplication that can be bound to vpnvserver.
vpnvserver_appcontroller_binding <vpnvserver_appcontroller_binding[]> Read-only appcontroller that can be bound to vpnvserver.
vpnvserver_rewritepolicy_binding <vpnvserver_rewritepolicy_binding[]> Read-only rewritepolicy that can be bound to vpnvserver.
vpnvserver_vpnportaltheme_binding <vpnvserver_vpnportaltheme_binding[]> Read-only vpnportaltheme that can be bound to vpnvserver.
vpnvserver_cspolicy_binding <vpnvserver_cspolicy_binding[]> Read-only cspolicy that can be bound to vpnvserver.
vpnvserver_auditsyslogpolicy_binding <vpnvserver_auditsyslogpolicy_binding[]> Read-only auditsyslogpolicy that can be bound to vpnvserver.
vpnvserver_authenticationcertpolicy_binding <vpnvserver_authenticationcertpolicy_binding[]> Read-only authenticationcertpolicy that can be bound to vpnvserver.
vpnvserver_vpnepaprofile_binding <vpnvserver_vpnepaprofile_binding[]> Read-only vpnepaprofile that can be bound to vpnvserver.
vpnvserver_vpnurl_binding <vpnvserver_vpnurl_binding[]> Read-only vpnurl that can be bound to vpnvserver.
vpnvserver_authenticationoauthidppolicy_binding <vpnvserver_authenticationoauthidppolicy_binding[]> Read-only authenticationoauthidppolicy that can be bound to vpnvserver.
vpnvserver_auditnslogpolicy_binding <vpnvserver_auditnslogpolicy_binding[]> Read-only auditnslogpolicy that can be bound to vpnvserver.
vpnvserver_authenticationpolicy_binding <vpnvserver_authenticationpolicy_binding[]> Read-only authenticationpolicy that can be bound to vpnvserver.
vpnvserver_vpneula_binding <vpnvserver_vpneula_binding[]> Read-only vpneula that can be bound to vpnvserver.
vpnvserver_icapolicy_binding <vpnvserver_icapolicy_binding[]> Read-only icapolicy that can be bound to vpnvserver.
vpnvserver_vpnclientlessaccesspolicy_binding <vpnvserver_vpnclientlessaccesspolicy_binding[]> Read-only vpnclientlessaccesspolicy that can be bound to vpnvserver.
vpnvserver_intranetip_binding <vpnvserver_intranetip_binding[]> Read-only intranetip that can be bound to vpnvserver.
vpnvserver_analyticsprofile_binding <vpnvserver_analyticsprofile_binding[]> Read-only analyticsprofile that can be bound to vpnvserver.
vpnvserver_appflowpolicy_binding <vpnvserver_appflowpolicy_binding[]> Read-only appflowpolicy that can be bound to vpnvserver.
vpnvserver_responderpolicy_binding <vpnvserver_responderpolicy_binding[]> Read-only responderpolicy that can be bound to vpnvserver.
vpnvserver_vpntrafficpolicy_binding <vpnvserver_vpntrafficpolicy_binding[]> Read-only vpntrafficpolicy that can be bound to vpnvserver.
vpnvserver_authenticationnegotiatepolicy_binding <vpnvserver_authenticationnegotiatepolicy_binding[]> Read-only authenticationnegotiatepolicy that can be bound to vpnvserver.
vpnvserver_feopolicy_binding <vpnvserver_feopolicy_binding[]> Read-only feopolicy that can be bound to vpnvserver.
vpnvserver_aaapreauthenticationpolicy_binding <vpnvserver_aaapreauthenticationpolicy_binding[]> Read-only aaapreauthenticationpolicy that can be bound to vpnvserver.
vpnvserver_cachepolicy_binding <vpnvserver_cachepolicy_binding[]> Read-only cachepolicy that can be bound to vpnvserver.
vpnvserver_authenticationtacacspolicy_binding <vpnvserver_authenticationtacacspolicy_binding[]> Read-only authenticationtacacspolicy that can be bound to vpnvserver.
vpnvserver_authenticationsamlpolicy_binding <vpnvserver_authenticationsamlpolicy_binding[]> Read-only authenticationsamlpolicy that can be bound to vpnvserver.
vpnvserver_authenticationdfapolicy_binding <vpnvserver_authenticationdfapolicy_binding[]> Read-only authenticationdfapolicy that can be bound to vpnvserver.
vpnvserver_staserver_binding <vpnvserver_staserver_binding[]> Read-only staserver that can be bound to vpnvserver.
vpnvserver_authenticationloginschemapolicy_binding <vpnvserver_authenticationloginschemapolicy_binding[]> Read-only authenticationloginschemapolicy that can be bound to vpnvserver.

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/vpnvserver_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: 


{ "vpnvserver_binding": [ {
      "name":<String_value>,
      "vpnvserver_vpnurlpolicy_binding":<vpnvserver_vpnurlpolicy_binding[]_value>,
      "vpnvserver_authenticationoauthidppolicy_binding":<vpnvserver_authenticationoauthidppolicy_binding[]_value>,
      "vpnvserver_authenticationloginschemapolicy_binding":<vpnvserver_authenticationloginschemapolicy_binding[]_value>,
      "vpnvserver_authenticationsamlpolicy_binding":<vpnvserver_authenticationsamlpolicy_binding[]_value>,
      "vpnvserver_cspolicy_binding":<vpnvserver_cspolicy_binding[]_value>,
      "vpnvserver_icapolicy_binding":<vpnvserver_icapolicy_binding[]_value>,
      "vpnvserver_vpnportaltheme_binding":<vpnvserver_vpnportaltheme_binding[]_value>,
      "vpnvserver_analyticsprofile_binding":<vpnvserver_analyticsprofile_binding[]_value>,
      "vpnvserver_appflowpolicy_binding":<vpnvserver_appflowpolicy_binding[]_value>,
      "vpnvserver_intranetip_binding":<vpnvserver_intranetip_binding[]_value>,
      "vpnvserver_vpntrafficpolicy_binding":<vpnvserver_vpntrafficpolicy_binding[]_value>,
      "vpnvserver_vpnepaprofile_binding":<vpnvserver_vpnepaprofile_binding[]_value>,
      "vpnvserver_authenticationtacacspolicy_binding":<vpnvserver_authenticationtacacspolicy_binding[]_value>,
      "vpnvserver_vpnintranetapplication_binding":<vpnvserver_vpnintranetapplication_binding[]_value>,
      "vpnvserver_authenticationradiuspolicy_binding":<vpnvserver_authenticationradiuspolicy_binding[]_value>,
      "vpnvserver_authenticationpolicy_binding":<vpnvserver_authenticationpolicy_binding[]_value>,
      "vpnvserver_aaapreauthenticationpolicy_binding":<vpnvserver_aaapreauthenticationpolicy_binding[]_value>,
      "vpnvserver_feopolicy_binding":<vpnvserver_feopolicy_binding[]_value>,
      "vpnvserver_authenticationlocalpolicy_binding":<vpnvserver_authenticationlocalpolicy_binding[]_value>,
      "vpnvserver_intranetip6_binding":<vpnvserver_intranetip6_binding[]_value>,
      "vpnvserver_vpnsessionpolicy_binding":<vpnvserver_vpnsessionpolicy_binding[]_value>,
      "vpnvserver_staserver_binding":<vpnvserver_staserver_binding[]_value>,
      "vpnvserver_authenticationcertpolicy_binding":<vpnvserver_authenticationcertpolicy_binding[]_value>,
      "vpnvserver_authenticationsamlidppolicy_binding":<vpnvserver_authenticationsamlidppolicy_binding[]_value>,
      "vpnvserver_vpnnexthopserver_binding":<vpnvserver_vpnnexthopserver_binding[]_value>,
      "vpnvserver_auditnslogpolicy_binding":<vpnvserver_auditnslogpolicy_binding[]_value>,
      "vpnvserver_auditsyslogpolicy_binding":<vpnvserver_auditsyslogpolicy_binding[]_value>,
      "vpnvserver_sharefileserver_binding":<vpnvserver_sharefileserver_binding[]_value>,
      "vpnvserver_responderpolicy_binding":<vpnvserver_responderpolicy_binding[]_value>,
      "vpnvserver_vpnurl_binding":<vpnvserver_vpnurl_binding[]_value>,
      "vpnvserver_cachepolicy_binding":<vpnvserver_cachepolicy_binding[]_value>,
      "vpnvserver_authenticationldappolicy_binding":<vpnvserver_authenticationldappolicy_binding[]_value>,
      "vpnvserver_authenticationwebauthpolicy_binding":<vpnvserver_authenticationwebauthpolicy_binding[]_value>,
      "vpnvserver_rewritepolicy_binding":<vpnvserver_rewritepolicy_binding[]_value>,
      "vpnvserver_authenticationnegotiatepolicy_binding":<vpnvserver_authenticationnegotiatepolicy_binding[]_value>,
      "vpnvserver_appcontroller_binding":<vpnvserver_appcontroller_binding[]_value>,
      "vpnvserver_vpnclientlessaccesspolicy_binding":<vpnvserver_vpnclientlessaccesspolicy_binding[]_value>,
      "vpnvserver_authenticationdfapolicy_binding":<vpnvserver_authenticationdfapolicy_binding[]_value>,
      "vpnvserver_vpneula_binding":<vpnvserver_vpneula_binding[]_value>
}]}

<!--NeedCopy-->

get (all)

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

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters:

bulkbindings

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


{ "vpnvserver_binding": [ {
      "name":<String_value>,
      "vpnvserver_vpnurlpolicy_binding":<vpnvserver_vpnurlpolicy_binding[]_value>,
      "vpnvserver_authenticationoauthidppolicy_binding":<vpnvserver_authenticationoauthidppolicy_binding[]_value>,
      "vpnvserver_authenticationloginschemapolicy_binding":<vpnvserver_authenticationloginschemapolicy_binding[]_value>,
      "vpnvserver_authenticationsamlpolicy_binding":<vpnvserver_authenticationsamlpolicy_binding[]_value>,
      "vpnvserver_cspolicy_binding":<vpnvserver_cspolicy_binding[]_value>,
      "vpnvserver_icapolicy_binding":<vpnvserver_icapolicy_binding[]_value>,
      "vpnvserver_vpnportaltheme_binding":<vpnvserver_vpnportaltheme_binding[]_value>,
      "vpnvserver_analyticsprofile_binding":<vpnvserver_analyticsprofile_binding[]_value>,
      "vpnvserver_appflowpolicy_binding":<vpnvserver_appflowpolicy_binding[]_value>,
      "vpnvserver_intranetip_binding":<vpnvserver_intranetip_binding[]_value>,
      "vpnvserver_vpntrafficpolicy_binding":<vpnvserver_vpntrafficpolicy_binding[]_value>,
      "vpnvserver_vpnepaprofile_binding":<vpnvserver_vpnepaprofile_binding[]_value>,
      "vpnvserver_authenticationtacacspolicy_binding":<vpnvserver_authenticationtacacspolicy_binding[]_value>,
      "vpnvserver_vpnintranetapplication_binding":<vpnvserver_vpnintranetapplication_binding[]_value>,
      "vpnvserver_authenticationradiuspolicy_binding":<vpnvserver_authenticationradiuspolicy_binding[]_value>,
      "vpnvserver_authenticationpolicy_binding":<vpnvserver_authenticationpolicy_binding[]_value>,
      "vpnvserver_aaapreauthenticationpolicy_binding":<vpnvserver_aaapreauthenticationpolicy_binding[]_value>,
      "vpnvserver_feopolicy_binding":<vpnvserver_feopolicy_binding[]_value>,
      "vpnvserver_authenticationlocalpolicy_binding":<vpnvserver_authenticationlocalpolicy_binding[]_value>,
      "vpnvserver_intranetip6_binding":<vpnvserver_intranetip6_binding[]_value>,
      "vpnvserver_vpnsessionpolicy_binding":<vpnvserver_vpnsessionpolicy_binding[]_value>,
      "vpnvserver_staserver_binding":<vpnvserver_staserver_binding[]_value>,
      "vpnvserver_authenticationcertpolicy_binding":<vpnvserver_authenticationcertpolicy_binding[]_value>,
      "vpnvserver_authenticationsamlidppolicy_binding":<vpnvserver_authenticationsamlidppolicy_binding[]_value>,
      "vpnvserver_vpnnexthopserver_binding":<vpnvserver_vpnnexthopserver_binding[]_value>,
      "vpnvserver_auditnslogpolicy_binding":<vpnvserver_auditnslogpolicy_binding[]_value>,
      "vpnvserver_auditsyslogpolicy_binding":<vpnvserver_auditsyslogpolicy_binding[]_value>,
      "vpnvserver_sharefileserver_binding":<vpnvserver_sharefileserver_binding[]_value>,
      "vpnvserver_responderpolicy_binding":<vpnvserver_responderpolicy_binding[]_value>,
      "vpnvserver_vpnurl_binding":<vpnvserver_vpnurl_binding[]_value>,
      "vpnvserver_cachepolicy_binding":<vpnvserver_cachepolicy_binding[]_value>,
      "vpnvserver_authenticationldappolicy_binding":<vpnvserver_authenticationldappolicy_binding[]_value>,
      "vpnvserver_authenticationwebauthpolicy_binding":<vpnvserver_authenticationwebauthpolicy_binding[]_value>,
      "vpnvserver_rewritepolicy_binding":<vpnvserver_rewritepolicy_binding[]_value>,
      "vpnvserver_authenticationnegotiatepolicy_binding":<vpnvserver_authenticationnegotiatepolicy_binding[]_value>,
      "vpnvserver_appcontroller_binding":<vpnvserver_appcontroller_binding[]_value>,
      "vpnvserver_vpnclientlessaccesspolicy_binding":<vpnvserver_vpnclientlessaccesspolicy_binding[]_value>,
      "vpnvserver_authenticationdfapolicy_binding":<vpnvserver_authenticationdfapolicy_binding[]_value>,
      "vpnvserver_vpneula_binding":<vpnvserver_vpneula_binding[]_value>
}]}

<!--NeedCopy-->
vpnvserver_binding
August 17, 2023
Contributed by: 
C
August 17, 2023
Contributed by: 
C

In this article

Site feedback | Your privacy choices footer linkYour Privacy Choices | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.