Skip to content

vpnvserver_binding

Binding object which returns the resources bound to vpnvserver.

Properties

(click to see Operations)

NameData TypePermissionsDescription
name<String>Read-writeName of the Citrix Gateway virtual server for which to show detailed information.
Minimum length = 1
vpnvserver_intranetip6_binding<vpnvserver_intranetip6_binding[]>Read-onlyintranetip6 that can be bound to vpnvserver.
vpnvserver_authenticationradiuspolicy_binding<vpnvserver_authenticationradiuspolicy_binding[]>Read-onlyauthenticationradiuspolicy that can be bound to vpnvserver.
vpnvserver_vpnsessionpolicy_binding<vpnvserver_vpnsessionpolicy_binding[]>Read-onlyvpnsessionpolicy that can be bound to vpnvserver.
vpnvserver_vpnurlpolicy_binding<vpnvserver_vpnurlpolicy_binding[]>Read-onlyvpnurlpolicy that can be bound to vpnvserver.
vpnvserver_vpnnexthopserver_binding<vpnvserver_vpnnexthopserver_binding[]>Read-onlyvpnnexthopserver that can be bound to vpnvserver.
vpnvserver_authenticationldappolicy_binding<vpnvserver_authenticationldappolicy_binding[]>Read-onlyauthenticationldappolicy that can be bound to vpnvserver.
vpnvserver_authenticationsamlidppolicy_binding<vpnvserver_authenticationsamlidppolicy_binding[]>Read-onlyauthenticationsamlidppolicy that can be bound to vpnvserver.
vpnvserver_authenticationwebauthpolicy_binding<vpnvserver_authenticationwebauthpolicy_binding[]>Read-onlyauthenticationwebauthpolicy that can be bound to vpnvserver.
vpnvserver_sharefileserver_binding<vpnvserver_sharefileserver_binding[]>Read-onlysharefileserver that can be bound to vpnvserver.
vpnvserver_authenticationlocalpolicy_binding<vpnvserver_authenticationlocalpolicy_binding[]>Read-onlyauthenticationlocalpolicy that can be bound to vpnvserver.
vpnvserver_vpnintranetapplication_binding<vpnvserver_vpnintranetapplication_binding[]>Read-onlyvpnintranetapplication that can be bound to vpnvserver.
vpnvserver_appcontroller_binding<vpnvserver_appcontroller_binding[]>Read-onlyappcontroller that can be bound to vpnvserver.
vpnvserver_rewritepolicy_binding<vpnvserver_rewritepolicy_binding[]>Read-onlyrewritepolicy that can be bound to vpnvserver.
vpnvserver_vpnportaltheme_binding<vpnvserver_vpnportaltheme_binding[]>Read-onlyvpnportaltheme that can be bound to vpnvserver.
vpnvserver_cspolicy_binding<vpnvserver_cspolicy_binding[]>Read-onlycspolicy that can be bound to vpnvserver.
vpnvserver_auditsyslogpolicy_binding<vpnvserver_auditsyslogpolicy_binding[]>Read-onlyauditsyslogpolicy that can be bound to vpnvserver.
vpnvserver_authenticationcertpolicy_binding<vpnvserver_authenticationcertpolicy_binding[]>Read-onlyauthenticationcertpolicy that can be bound to vpnvserver.
vpnvserver_vpnepaprofile_binding<vpnvserver_vpnepaprofile_binding[]>Read-onlyvpnepaprofile that can be bound to vpnvserver.
vpnvserver_vpnurl_binding<vpnvserver_vpnurl_binding[]>Read-onlyvpnurl that can be bound to vpnvserver.
vpnvserver_authenticationoauthidppolicy_binding<vpnvserver_authenticationoauthidppolicy_binding[]>Read-onlyauthenticationoauthidppolicy that can be bound to vpnvserver.
vpnvserver_auditnslogpolicy_binding<vpnvserver_auditnslogpolicy_binding[]>Read-onlyauditnslogpolicy that can be bound to vpnvserver.
vpnvserver_authenticationpolicy_binding<vpnvserver_authenticationpolicy_binding[]>Read-onlyauthenticationpolicy that can be bound to vpnvserver.
vpnvserver_vpneula_binding<vpnvserver_vpneula_binding[]>Read-onlyvpneula that can be bound to vpnvserver.
vpnvserver_icapolicy_binding<vpnvserver_icapolicy_binding[]>Read-onlyicapolicy that can be bound to vpnvserver.
vpnvserver_vpnclientlessaccesspolicy_binding<vpnvserver_vpnclientlessaccesspolicy_binding[]>Read-onlyvpnclientlessaccesspolicy that can be bound to vpnvserver.
vpnvserver_intranetip_binding<vpnvserver_intranetip_binding[]>Read-onlyintranetip that can be bound to vpnvserver.
vpnvserver_appflowpolicy_binding<vpnvserver_appflowpolicy_binding[]>Read-onlyappflowpolicy that can be bound to vpnvserver.
vpnvserver_responderpolicy_binding<vpnvserver_responderpolicy_binding[]>Read-onlyresponderpolicy that can be bound to vpnvserver.
vpnvserver_vpntrafficpolicy_binding<vpnvserver_vpntrafficpolicy_binding[]>Read-onlyvpntrafficpolicy that can be bound to vpnvserver.
vpnvserver_authenticationnegotiatepolicy_binding<vpnvserver_authenticationnegotiatepolicy_binding[]>Read-onlyauthenticationnegotiatepolicy that can be bound to vpnvserver.
vpnvserver_feopolicy_binding<vpnvserver_feopolicy_binding[]>Read-onlyfeopolicy that can be bound to vpnvserver.
vpnvserver_aaapreauthenticationpolicy_binding<vpnvserver_aaapreauthenticationpolicy_binding[]>Read-onlyaaapreauthenticationpolicy that can be bound to vpnvserver.
vpnvserver_cachepolicy_binding<vpnvserver_cachepolicy_binding[]>Read-onlycachepolicy that can be bound to vpnvserver.
vpnvserver_authenticationtacacspolicy_binding<vpnvserver_authenticationtacacspolicy_binding[]>Read-onlyauthenticationtacacspolicy that can be bound to vpnvserver.
vpnvserver_authenticationsamlpolicy_binding<vpnvserver_authenticationsamlpolicy_binding[]>Read-onlyauthenticationsamlpolicy that can be bound to vpnvserver.
vpnvserver_authenticationdfapolicy_binding<vpnvserver_authenticationdfapolicy_binding[]>Read-onlyauthenticationdfapolicy that can be bound to vpnvserver.
vpnvserver_staserver_binding<vpnvserver_staserver_binding[]>Read-onlystaserver that can be bound to vpnvserver.
vpnvserver_authenticationloginschemapolicy_binding<vpnvserver_authenticationloginschemapolicy_binding[]>Read-onlyauthenticationloginschemapolicy 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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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 redand placeholder content is marked in <green>.

get

URL:http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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_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>
}]}

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnvserver_binding

Query-parameters:

bulkbindings

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnvserver_binding?bulkbindings=yes

NITRO allows you to fetch bindings in bulk.

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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

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_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>
}]}