Try SpotterConfiguration for VPN virtual server resource.
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Configuration for VPN virtual server resource.
dtls:
choices:
- 'ON'
- 'OFF'
description:
- This option starts/stops the turn service on the vserver
type: str
name:
description:
- Name for the Citrix Gateway virtual server. Must begin with an ASCII alphabetic
or underscore (_) character, and must contain only ASCII alphanumeric, underscore,
hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
Can be changed after the virtual server is created.
- ''
- 'The following requirement applies only to the Citrix ADC CLI:'
- If the name includes one or more spaces, enclose the name in double or single quotation
marks (for example, "my server" or 'my server').
type: str
nsip:
description:
- The ip address of the NetScaler ADC appliance where the nitro API calls will be
made.
- The port can be specified with the colon (:). E.g. 192.168.1.1:555.
required: true
type: str
port:
description:
- TCP port on which the virtual server listens.
type: int
ipset:
description:
- The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service
on the current vpn vserver
type: str
ipv46:
description:
- IPv4 or IPv6 address of the Citrix Gateway virtual server. Usually a public IP address.
User devices send connection requests to this IP address.
type: str
range:
description:
- Range of Citrix Gateway virtual server IP addresses. The consecutively numbered
range of IP addresses begins with the address specified by the IP Address parameter.
- In the configuration utility, select Network VServer to enter a range.
type: float
state:
choices:
- present
- absent
- enabled
- disabled
- unset
default: present
description:
- The state of the resource being configured by the module on the NetScaler ADC node.
- When C(present), the resource will be added/updated configured according to the
module's parameters.
- When C(absent), the resource will be deleted from the NetScaler ADC node.
- When C(enabled), the resource will be enabled on the NetScaler ADC node.
- When C(disabled), the resource will be disabled on the NetScaler ADC node.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
l2conn:
choices:
- 'ON'
- 'OFF'
description:
- Use Layer 2 parameters (channel number, MAC address, and VLAN ID) in addition to
the 4-tuple (<source IP>:<source port>::<destination IP>:<destination port>) that
is used to identify a connection. Allows multiple TCP and non-TCP connections with
the same 4-tuple to coexist on the Citrix ADC.
type: str
comment:
description:
- Any comments associated with the virtual server.
type: str
icaonly:
choices:
- 'ON'
- 'OFF'
description:
- '- When set to C(ON), it implies Basic mode where the user can log on using either
Citrix Receiver or a browser and get access to the published apps configured at
the XenApp/XenDEsktop environment pointed out by the WIHome parameter. Users are
not allowed to connect using the Citrix Gateway Plug-in and end point scans cannot
be configured. Number of users that can log in and access the apps are not limited
by the license in this mode.'
- ''
- '- When set to C(OFF), it implies Smart Access mode where the user can log on using
either Citrix Receiver or a browser or a Citrix Gateway Plug-in. The admin can configure
end point scans to be run on the client systems and then use the results to control
access to the published apps. In this mode, the client can connect to the gateway
in other client modes namely VPN and CVPN. Number of users that can log in and access
the resources are limited by the CCU licenses in this mode.'
type: str
newname:
description:
- New name for the Citrix Gateway virtual server. Must begin with an ASCII alphabetic
or underscore (_) character, and must contain only ASCII alphanumeric, underscore,
hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters.
- ''
- 'The following requirement applies only to the Citrix ADC CLI:'
- If the name includes one or more spaces, enclose the name in double or single quotation
marks (for example, "my server" or 'my server').
type: str
api_path:
default: nitro/v1/config
description:
- Base NITRO API path.
- Define only in case of an ADM service proxy call
type: str
rhistate:
choices:
- PASSIVE
- ACTIVE
description:
- A host route is injected according to the setting on the virtual servers.
- ' * If set to C(PASSIVE) on all the virtual servers that share the IP
address, the appliance always injects the hostroute.'
- ' * If set to C(ACTIVE) on all the virtual servers that share the IP
address, the appliance injects even if one virtual server is UP.'
- ' * If set to C(ACTIVE) on some virtual servers and C(PASSIVE) on the
others, the appliance injects even if one virtual server set to C(ACTIVE) is UP.'
type: str
samesite:
choices:
- None
- LAX
- STRICT
description:
- SameSite attribute value for Cookies generated in VPN context. This attribute value
will be appended only for the cookies which are specified in the builtin patset
ns_cookies_samesite
type: str
doublehop:
choices:
- ENABLED
- DISABLED
description:
- Use the Citrix Gateway appliance in a double-hop configuration. A double-hop deployment
provides an extra layer of security for the internal network by using three firewalls
to divide the DMZ into two stages. Such a deployment can have one appliance in the
DMZ and one appliance in the secure network.
type: str
loginonce:
choices:
- 'ON'
- 'OFF'
description:
- This option enables/disables seamless SSO for this Vserver.
type: str
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Log AppFlow records that contain standard NetFlow or IPFIX information, such as
time stamps for the beginning and end of a flow, packet count, and byte count. Also
log records that contain application-level information, such as HTTP web addresses,
HTTP request methods and response status codes, server response time, and latency.
type: str
devicecert:
choices:
- 'ON'
- 'OFF'
description:
- Indicates whether device certificate check as a part of EPA is on or off.
type: str
netprofile:
description:
- The name of the network profile.
type: str
nitro_pass:
description:
- The password with which to authenticate to the NetScaler ADC node.
required: false
type: str
nitro_user:
description:
- The username with which to authenticate to the NetScaler ADC node.
required: false
type: str
advancedepa:
choices:
- 'ON'
- 'OFF'
description:
- This option tells whether advanced EPA is enabled on this virtual server
type: str
maxaaausers:
description:
- Maximum number of concurrent user sessions allowed on this virtual server. The actual
number of users allowed to log on to this virtual server depends on the total number
of user licenses.
type: float
save_config:
default: false
description:
- If C(true) the module will save the configuration on the NetScaler ADC node if it
makes any changes.
- The module will not save the configuration on the NetScaler ADC node if it made
no changes.
type: bool
servicetype:
choices:
- SSL
- DTLS
description:
- Protocol used by the Citrix Gateway virtual server.
type: str
userdomains:
description:
- List of user domains specified as comma seperated value
type: str
vserverfqdn:
description:
- Fully qualified domain name for a VPN virtual server. This is used during StoreFront
configuration generation.
type: str
authnprofile:
description:
- Authentication Profile entity on virtual server. This entity can be used to offload
authentication to AAA vserver for multi-factor(nFactor) authentication
type: str
certkeynames:
description:
- Name of the certificate key that was bound to the corresponding SSL virtual server
as the Certificate Authority for the device certificate
type: str
listenpolicy:
description:
- String specifying the listen policy for the Citrix Gateway virtual server. Can be
either a named expression or an expression. The Citrix Gateway virtual server processes
only the traffic for which the expression evaluates to true.
type: str
authentication:
choices:
- 'ON'
- 'OFF'
description:
- Require authentication for users connecting to Citrix Gateway.
type: str
deploymenttype:
choices:
- NONE
- ICA_WEBINTERFACE
- ICA_STOREFRONT
- MOBILITY
description:
- '0'
type: str
downstateflush:
choices:
- ENABLED
- DISABLED
description:
- Close existing connections when the virtual server is marked DOWN, which means the
server might have timed out. Disconnecting existing connections frees resources
and in certain cases speeds recovery of overloaded load balancing setups. Enable
this setting on servers in which the connections can safely be closed when they
are marked DOWN. Do not enable DOWN state flush on servers that must complete their
transactions.
type: str
listenpriority:
description:
- Integer specifying the priority of the listen policy. A higher number specifies
a lower priority. If a request matches the listen policies of more than one virtual
server, the virtual server whose listen policy has the highest priority (the lowest
priority number) accepts the request.
type: float
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
tcpprofilename:
description:
- Name of the TCP profile to assign to this virtual server.
type: str
validate_certs:
default: true
description:
- If C(false), SSL certificates will not be validated. This should only be used on
personally controlled sites using self-signed certificates.
required: false
type: bool
httpprofilename:
description:
- Name of the HTTP profile to assign to this virtual server.
type: str
icmpvsrresponse:
choices:
- PASSIVE
- ACTIVE
description:
- Criterion for responding to PING requests sent to this virtual server. If this parameter
is set to C(ACTIVE), respond only if the virtual server is available. With the C(PASSIVE)
setting, respond even if the virtual server is not available.
type: str
maxloginattempts:
description:
- Maximum number of logon attempts
type: float
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
failedlogintimeout:
description:
- Number of minutes an account will be locked if user exceeds maximum permissible
attempts
type: float
macepapluginupgrade:
choices:
- Always
- Essential
- Never
description:
- Option to set plugin upgrade behaviour for Mac
type: str
rdpserverprofilename:
description:
- Name of the RDP server profile associated with the vserver.
type: str
linuxepapluginupgrade:
choices:
- Always
- Essential
- Never
description:
- Option to set plugin upgrade behaviour for Linux
type: str
cginfrahomepageredirect:
choices:
- ENABLED
- DISABLED
description:
- When client requests ShareFile resources and Citrix Gateway detects that the user
is unauthenticated or the user session has expired, disabling this option takes
the user to the originally requested ShareFile resource after authentication (instead
of taking the user to the default VPN home page)
type: str
pcoipvserverprofilename:
description:
- Name of the PCoIP vserver profile associated with the vserver.
type: str
windowsepapluginupgrade:
choices:
- Always
- Essential
- Never
description:
- Option to set plugin upgrade behaviour for Win
type: str
icaproxysessionmigration:
choices:
- 'ON'
- 'OFF'
description:
- This option determines if an existing ICA Proxy session is transferred when the
user logs on from another device.
type: str
logoutonsmartcardremoval:
choices:
- 'ON'
- 'OFF'
description:
- Option to VPN plugin behavior when smartcard or its reader is removed
type: str
vpnvserver_vpnurl_binding:
description: Bindings for vpnvserver_vpnurl_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpneula_binding:
description: Bindings for vpnvserver_vpneula_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_cspolicy_binding:
description: Bindings for vpnvserver_cspolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_feopolicy_binding:
description: Bindings for vpnvserver_feopolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_icapolicy_binding:
description: Bindings for vpnvserver_icapolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_staserver_binding:
description: Bindings for vpnvserver_staserver_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_intranetip_binding:
description: Bindings for vpnvserver_intranetip_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_cachepolicy_binding:
description: Bindings for vpnvserver_cachepolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_intranetip6_binding:
description: Bindings for vpnvserver_intranetip6_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnurlpolicy_binding:
description: Bindings for vpnvserver_vpnurlpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_appcontroller_binding:
description: Bindings for vpnvserver_appcontroller_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_appflowpolicy_binding:
description: Bindings for vpnvserver_appflowpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_rewritepolicy_binding:
description: Bindings for vpnvserver_rewritepolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnepaprofile_binding:
description: Bindings for vpnvserver_vpnepaprofile_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnportaltheme_binding:
description: Bindings for vpnvserver_vpnportaltheme_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_responderpolicy_binding:
description: Bindings for vpnvserver_responderpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_sharefileserver_binding:
description: Bindings for vpnvserver_sharefileserver_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_analyticsprofile_binding:
description: Bindings for vpnvserver_analyticsprofile_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_auditnslogpolicy_binding:
description: Bindings for vpnvserver_auditnslogpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnnexthopserver_binding:
description: Bindings for vpnvserver_vpnnexthopserver_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnsessionpolicy_binding:
description: Bindings for vpnvserver_vpnsessionpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpntrafficpolicy_binding:
description: Bindings for vpnvserver_vpntrafficpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_auditsyslogpolicy_binding:
description: Bindings for vpnvserver_auditsyslogpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationpolicy_binding:
description: Bindings for vpnvserver_authenticationpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnintranetapplication_binding:
description: Bindings for vpnvserver_vpnintranetapplication_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationdfapolicy_binding:
description: Bindings for vpnvserver_authenticationdfapolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationcertpolicy_binding:
description: Bindings for vpnvserver_authenticationcertpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationldappolicy_binding:
description: Bindings for vpnvserver_authenticationldappolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationsamlpolicy_binding:
description: Bindings for vpnvserver_authenticationsamlpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationlocalpolicy_binding:
description: Bindings for vpnvserver_authenticationlocalpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_vpnclientlessaccesspolicy_binding:
description: Bindings for vpnvserver_vpnclientlessaccesspolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_aaapreauthenticationpolicy_binding:
description: Bindings for vpnvserver_aaapreauthenticationpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationradiuspolicy_binding:
description: Bindings for vpnvserver_authenticationradiuspolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationtacacspolicy_binding:
description: Bindings for vpnvserver_authenticationtacacspolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationsamlidppolicy_binding:
description: Bindings for vpnvserver_authenticationsamlidppolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationwebauthpolicy_binding:
description: Bindings for vpnvserver_authenticationwebauthpolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationoauthidppolicy_binding:
description: Bindings for vpnvserver_authenticationoauthidppolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationnegotiatepolicy_binding:
description: Bindings for vpnvserver_authenticationnegotiatepolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
vpnvserver_authenticationloginschemapolicy_binding:
description: Bindings for vpnvserver_authenticationloginschemapolicy_binding resource
suboptions:
binding_members:
default: []
description: List of binding members
elements: dict
type: list
mode:
choices:
- desired
- bind
- unbind
default: desired
description:
- The mode in which to configure the bindings.
- If mode is set to C(desired), the bindings will be added or removed from the
target NetScaler ADCs as necessary to match the bindings specified in the state.
- If mode is set to C(bind), the specified bindings will be added to the resource.
The existing bindings in the target ADCs will not be modified.
- If mode is set to C(unbind), the specified bindings will be removed from the
resource. The existing bindings in the target ADCs will not be modified.
type: str
type: dict
changed:
description: Indicates if any change is made by the module
returned: always
sample: true
type: bool
diff:
description: Dictionary of before and after changes
returned: always
sample:
after:
key2: pqr
before:
key1: xyz
prepared: changes done
type: dict
diff_list:
description: List of differences between the actual configured object and the configuration
specified in the module
returned: when changed
sample:
- 'Attribute `key1` differs. Desired: (<class ''str''>) XYZ. Existing: (<class ''str''>)
PQR'
type: list
failed:
description: Indicates if the module failed or not
returned: always
sample: false
type: bool
loglines:
description: list of logged messages by the module
returned: always
sample:
- message 1
- message 2
type: list