ADC NITRO APIs

vpnglobal_binding

Binding object which returns the resources bound to vpnglobal.

Properties

(click to see Operations )

Name Data Type Permissions Description
vpnglobal_intranetip6_binding <vpnglobal_intranetip6_binding[]> Read-write intranetip6 that can be bound to vpnglobal.
vpnglobal_auditnslogpolicy_binding <vpnglobal_auditnslogpolicy_binding[]> Read-write auditnslogpolicy that can be bound to vpnglobal.
vpnglobal_authenticationpolicy_binding <vpnglobal_authenticationpolicy_binding[]> Read-write authenticationpolicy that can be bound to vpnglobal.
vpnglobal_authenticationradiuspolicy_binding <vpnglobal_authenticationradiuspolicy_binding[]> Read-write authenticationradiuspolicy that can be bound to vpnglobal.
vpnglobal_vpnsessionpolicy_binding <vpnglobal_vpnsessionpolicy_binding[]> Read-write vpnsessionpolicy that can be bound to vpnglobal.
vpnglobal_domain_binding <vpnglobal_domain_binding[]> Read-write domain that can be bound to vpnglobal.
vpnglobal_vpneula_binding <vpnglobal_vpneula_binding[]> Read-write vpneula that can be bound to vpnglobal.
vpnglobal_vpnclientlessaccesspolicy_binding <vpnglobal_vpnclientlessaccesspolicy_binding[]> Read-write vpnclientlessaccesspolicy that can be bound to vpnglobal.
vpnglobal_vpnurlpolicy_binding <vpnglobal_vpnurlpolicy_binding[]> Read-write vpnurlpolicy that can be bound to vpnglobal.
vpnglobal_intranetip_binding <vpnglobal_intranetip_binding[]> Read-write intranetip that can be bound to vpnglobal.
vpnglobal_vpnnexthopserver_binding <vpnglobal_vpnnexthopserver_binding[]> Read-write vpnnexthopserver that can be bound to vpnglobal.
vpnglobal_authenticationldappolicy_binding <vpnglobal_authenticationldappolicy_binding[]> Read-write authenticationldappolicy that can be bound to vpnglobal.
vpnglobal_sharefileserver_binding <vpnglobal_sharefileserver_binding[]> Read-write sharefileserver that can be bound to vpnglobal.
vpnglobal_vpntrafficpolicy_binding <vpnglobal_vpntrafficpolicy_binding[]> Read-write vpntrafficpolicy that can be bound to vpnglobal.
vpnglobal_authenticationlocalpolicy_binding <vpnglobal_authenticationlocalpolicy_binding[]> Read-write authenticationlocalpolicy that can be bound to vpnglobal.
vpnglobal_vpnintranetapplication_binding <vpnglobal_vpnintranetapplication_binding[]> Read-write vpnintranetapplication that can be bound to vpnglobal.
vpnglobal_appcontroller_binding <vpnglobal_appcontroller_binding[]> Read-write appcontroller that can be bound to vpnglobal.
vpnglobal_authenticationnegotiatepolicy_binding <vpnglobal_authenticationnegotiatepolicy_binding[]> Read-write authenticationnegotiatepolicy that can be bound to vpnglobal.
vpnglobal_authenticationtacacspolicy_binding <vpnglobal_authenticationtacacspolicy_binding[]> Read-write authenticationtacacspolicy that can be bound to vpnglobal.
vpnglobal_vpnportaltheme_binding <vpnglobal_vpnportaltheme_binding[]> Read-write vpnportaltheme that can be bound to vpnglobal.
vpnglobal_authenticationsamlpolicy_binding <vpnglobal_authenticationsamlpolicy_binding[]> Read-write authenticationsamlpolicy that can be bound to vpnglobal.
vpnglobal_staserver_binding <vpnglobal_staserver_binding[]> Read-write staserver that can be bound to vpnglobal.
vpnglobal_auditsyslogpolicy_binding <vpnglobal_auditsyslogpolicy_binding[]> Read-write auditsyslogpolicy that can be bound to vpnglobal.
vpnglobal_authenticationcertpolicy_binding <vpnglobal_authenticationcertpolicy_binding[]> Read-write authenticationcertpolicy that can be bound to vpnglobal.
vpnglobal_vpnurl_binding <vpnglobal_vpnurl_binding[]> Read-write vpnurl that can be bound to vpnglobal.
vpnglobal_sslcertkey_binding <vpnglobal_sslcertkey_binding[]> Read-write sslcertkey that can be bound to vpnglobal.

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

{ "vpnglobal_binding": [ {
"vpnglobal_authenticationsamlpolicy_binding":<vpnglobal_authenticationsamlpolicy_binding[]_value>,
"vpnglobal_intranetip_binding":<vpnglobal_intranetip_binding[]_value>,
"vpnglobal_authenticationradiuspolicy_binding":<vpnglobal_authenticationradiuspolicy_binding[]_value>,
"vpnglobal_authenticationtacacspolicy_binding":<vpnglobal_authenticationtacacspolicy_binding[]_value>,
"vpnglobal_authenticationpolicy_binding":<vpnglobal_authenticationpolicy_binding[]_value>,
"vpnglobal_vpntrafficpolicy_binding":<vpnglobal_vpntrafficpolicy_binding[]_value>,
"vpnglobal_domain_binding":<vpnglobal_domain_binding[]_value>,
"vpnglobal_vpnnexthopserver_binding":<vpnglobal_vpnnexthopserver_binding[]_value>,
"vpnglobal_authenticationldappolicy_binding":<vpnglobal_authenticationldappolicy_binding[]_value>,
"vpnglobal_authenticationnegotiatepolicy_binding":<vpnglobal_authenticationnegotiatepolicy_binding[]_value>,
"vpnglobal_vpneula_binding":<vpnglobal_vpneula_binding[]_value>,
"vpnglobal_vpnclientlessaccesspolicy_binding":<vpnglobal_vpnclientlessaccesspolicy_binding[]_value>,
"vpnglobal_authenticationlocalpolicy_binding":<vpnglobal_authenticationlocalpolicy_binding[]_value>,
"vpnglobal_auditnslogpolicy_binding":<vpnglobal_auditnslogpolicy_binding[]_value>,
"vpnglobal_vpnintranetapplication_binding":<vpnglobal_vpnintranetapplication_binding[]_value>,
"vpnglobal_sslcertkey_binding":<vpnglobal_sslcertkey_binding[]_value>,
"vpnglobal_staserver_binding":<vpnglobal_staserver_binding[]_value>,
"vpnglobal_sharefileserver_binding":<vpnglobal_sharefileserver_binding[]_value>,
"vpnglobal_intranetip6_binding":<vpnglobal_intranetip6_binding[]_value>,
"vpnglobal_appcontroller_binding":<vpnglobal_appcontroller_binding[]_value>,
"vpnglobal_vpnsessionpolicy_binding":<vpnglobal_vpnsessionpolicy_binding[]_value>,
"vpnglobal_authenticationcertpolicy_binding":<vpnglobal_authenticationcertpolicy_binding[]_value>,
"vpnglobal_auditsyslogpolicy_binding":<vpnglobal_auditsyslogpolicy_binding[]_value>,
"vpnglobal_vpnurl_binding":<vpnglobal_vpnurl_binding[]_value>,
"vpnglobal_vpnportaltheme_binding":<vpnglobal_vpnportaltheme_binding[]_value>,
"vpnglobal_vpnurlpolicy_binding":<vpnglobal_vpnurlpolicy_binding[]_value>
}]}

<!--NeedCopy-->

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_binding HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Query-parameters: bulkbindings http:// <netscaler-ip-address> /nitro/v1/config/vpnglobal_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:

{ "vpnglobal_binding": [ {
"vpnglobal_authenticationsamlpolicy_binding":<vpnglobal_authenticationsamlpolicy_binding[]_value>,
"vpnglobal_intranetip_binding":<vpnglobal_intranetip_binding[]_value>,
"vpnglobal_authenticationradiuspolicy_binding":<vpnglobal_authenticationradiuspolicy_binding[]_value>,
"vpnglobal_authenticationtacacspolicy_binding":<vpnglobal_authenticationtacacspolicy_binding[]_value>,
"vpnglobal_authenticationpolicy_binding":<vpnglobal_authenticationpolicy_binding[]_value>,
"vpnglobal_vpntrafficpolicy_binding":<vpnglobal_vpntrafficpolicy_binding[]_value>,
"vpnglobal_domain_binding":<vpnglobal_domain_binding[]_value>,
"vpnglobal_vpnnexthopserver_binding":<vpnglobal_vpnnexthopserver_binding[]_value>,
"vpnglobal_authenticationldappolicy_binding":<vpnglobal_authenticationldappolicy_binding[]_value>,
"vpnglobal_authenticationnegotiatepolicy_binding":<vpnglobal_authenticationnegotiatepolicy_binding[]_value>,
"vpnglobal_vpneula_binding":<vpnglobal_vpneula_binding[]_value>,
"vpnglobal_vpnclientlessaccesspolicy_binding":<vpnglobal_vpnclientlessaccesspolicy_binding[]_value>,
"vpnglobal_authenticationlocalpolicy_binding":<vpnglobal_authenticationlocalpolicy_binding[]_value>,
"vpnglobal_auditnslogpolicy_binding":<vpnglobal_auditnslogpolicy_binding[]_value>,
"vpnglobal_vpnintranetapplication_binding":<vpnglobal_vpnintranetapplication_binding[]_value>,
"vpnglobal_sslcertkey_binding":<vpnglobal_sslcertkey_binding[]_value>,
"vpnglobal_staserver_binding":<vpnglobal_staserver_binding[]_value>,
"vpnglobal_sharefileserver_binding":<vpnglobal_sharefileserver_binding[]_value>,
"vpnglobal_intranetip6_binding":<vpnglobal_intranetip6_binding[]_value>,
"vpnglobal_appcontroller_binding":<vpnglobal_appcontroller_binding[]_value>,
"vpnglobal_vpnsessionpolicy_binding":<vpnglobal_vpnsessionpolicy_binding[]_value>,
"vpnglobal_authenticationcertpolicy_binding":<vpnglobal_authenticationcertpolicy_binding[]_value>,
"vpnglobal_auditsyslogpolicy_binding":<vpnglobal_auditsyslogpolicy_binding[]_value>,
"vpnglobal_vpnurl_binding":<vpnglobal_vpnurl_binding[]_value>,
"vpnglobal_vpnportaltheme_binding":<vpnglobal_vpnportaltheme_binding[]_value>,
"vpnglobal_vpnurlpolicy_binding":<vpnglobal_vpnurlpolicy_binding[]_value>
}]}

<!--NeedCopy-->
vpnglobal_binding