Try SpotterConfiguration for CR 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 CR virtual server resource.
td:
description:
- Integer value that uniquely identifies the traffic domain in which you want to configure
the entity. If you do not specify an ID, the entity becomes part of the default
traffic domain, which has an ID of 0.
type: float
arp:
choices:
- 'ON'
- 'OFF'
description:
- Use ARP to determine the destination MAC address.
type: str
map:
choices:
- 'ON'
- 'OFF'
description:
- Obsolete.
type: str
via:
choices:
- 'ON'
- 'OFF'
description:
- Insert a via header in each HTTP request. In the case of a cache miss, the request
is redirected from the cache server to the origin server. This header indicates
whether the request is being sent from a cache server.
type: str
name:
description:
- Name for the cache redirection virtual server. Must begin with an ASCII alphanumeric
or underscore (_) character, and must contain only ASCII alphanumeric, underscore,
hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen
(-) characters. Can be changed after the cache redirection 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:
- Port number of the virtual server.
type: int
ghost:
choices:
- 'ON'
- 'OFF'
description:
- '0'
type: str
ipset:
description:
- The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service
on the current cr vserver
type: str
ipv46:
description:
- IPv4 or IPv6 address of the cache redirection virtual server. Usually a public IP
address. Clients send connection requests to this IP address.
- 'Note: For a transparent cache redirection virtual server, use an asterisk (*) to
specify a wildcard virtual server address.'
type: str
range:
description:
- Number of consecutive IP addresses, starting with the address specified by the IPAddress
parameter, to include in a range of addresses assigned to this virtual server.
type: float
reuse:
choices:
- 'ON'
- 'OFF'
description:
- 'Reuse TCP connections to the origin server across client connections. Do not set
this parameter unless the Service Type parameter is set to HTTP. If you set this
parameter to C(OFF), the possible settings of the Redirect parameter function as
follows:'
- '* CACHE - TCP connections to the cache servers are not reused.'
- '* ORIGIN - TCP connections to the origin servers are not reused.'
- '* POLICY - TCP connections to the origin servers are not reused.'
- If you set the Reuse parameter to C(ON), connections to origin servers and connections
to cache servers are reused.
type: str
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
domain:
description:
- Default domain for reverse proxies. Domains are configured to direct an incoming
request from a specified source domain to a specified target domain. There can be
several configured pairs of source and target domains. You can select one pair to
be the default. If the host header or URL of an incoming request does not include
a source domain, this option sends the request to the specified target domain.
type: str
format:
choices:
- 'ON'
- 'OFF'
description:
- '0'
type: str
l2conn:
choices:
- 'ON'
- 'OFF'
description:
- Use L2 parameters, such as MAC, VLAN, and channel to identify a connection.
type: str
comment:
description:
- Comments associated with this virtual server.
type: str
newname:
description:
- New name for the cache redirection virtual server. Must begin with an ASCII alphanumeric
or underscore (_) character, and must contain only ASCII alphanumeric, underscore,
hash (#), period (.), space, colon (:), at sign (@), equal sign (=), and hyphen
(-) characters. If the name includes one or more spaces, enclose the name in double
or single quotation marks (for example, "my name" or 'my name').
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
redirect:
choices:
- CACHE
- POLICY
- ORIGIN
description:
- 'Type of cache server to which to redirect HTTP requests. Available settings function
as follows:'
- '* C(CACHE) - Direct all requests to the cache.'
- '* C(POLICY) - Apply the cache redirection policy to determine whether the request
should be directed to the cache or to the origin.'
- '* C(ORIGIN) - Direct all requests to the origin server.'
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
cachetype:
choices:
- TRANSPARENT
- REVERSE
- FORWARD
description:
- 'Mode of operation for the cache redirection virtual server. Available settings
function as follows:'
- '* C(TRANSPARENT) - Intercept all traffic flowing to the appliance and apply cache
redirection policies to determine whether content should be served from the cache
or from the origin server.'
- '* C(FORWARD) - Resolve the hostname of the incoming request, by using a DNS server,
and forward requests for non-cacheable content to the resolved origin servers. Cacheable
requests are sent to the configured cache servers.'
- '* C(REVERSE) - Configure reverse proxy caches for specific origin servers. Incoming
traffic directed to the reverse proxy can either be served from a cache server or
be sent to the origin server with or without modification to the URL.'
- The default value for cache type is C(TRANSPARENT) if service is HTTP or SSL whereas
the default cache type is C(FORWARD) if the service is HDX.
type: str
probeport:
description:
- Citrix ADC provides support for external health check of the vserver status. Select
port for HTTP/TCP monitring
type: int
srcipexpr:
description:
- Expression used to extract the source IP addresses from the requests originating
from the cache. Can be either an in-line expression or the name of a named expression.
type: str
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Enable logging of AppFlow information.
type: str
backendssl:
choices:
- ENABLED
- DISABLED
description:
- Decides whether the backend connection made by Citrix ADC to the origin server will
be HTTP or SSL. Applicable only for SSL type CR Forward proxy vserver.
type: str
clttimeout:
description:
- Time-out value, in seconds, after which to terminate an idle client connection.
type: float
netprofile:
description:
- Name of the network profile containing network configurations for the cache redirection
virtual server.
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
originusip:
choices:
- 'ON'
- 'OFF'
description:
- Use the client's IP address as the source IP address in requests sent to the origin
server.
- 'Note: You can enable this parameter to implement fully transparent CR deployment.'
type: str
precedence:
choices:
- RULE
- URL
description:
- 'Type of policy (C(URL) or C(RULE)) that takes precedence on the cache redirection
virtual server. Applies only to cache redirection virtual servers that have both
C(URL) and C(RULE) based policies. If you specify C(URL), C(URL) based policies
are applied first, in the following order:'
- 1. Domain and exact C(URL)
- 2. Domain, prefix and suffix
- 3. Domain and suffix
- 4. Domain and prefix
- 5. Domain only
- 6. Exact C(URL)
- 7. Prefix and suffix
- 8. Suffix only
- 9. Prefix only
- 10. Default
- If you specify C(RULE), the rule based policies are applied before C(URL) based
policies are applied.
type: str
redirecturl:
description:
- URL of the server to which to redirect traffic if the cache redirection virtual
server configured on the Citrix ADC becomes unavailable.
type: str
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:
- HTTP
- SSL
- NNTP
- HDX
description:
- Protocol (type of service) handled by the virtual server.
type: str
sothreshold:
description:
- For CONNECTION (or) DYNAMICCONNECTION spillover, the number of connections above
which the virtual server enters spillover mode. For BANDWIDTH spillover, the amount
of incoming and outgoing traffic (in Kbps) before spillover. For HEALTH spillover,
the percentage of active services (by weight) below which spillover occurs.
type: float
cachevserver:
description:
- Name of the default cache virtual server to which to redirect requests (the default
target of the cache redirection virtual server).
type: str
listenpolicy:
description:
- String specifying the listen policy for the cache redirection virtual server. Can
be either an in-line expression or the name of a named expression.
type: str
tcpprobeport:
description:
- Port number for external TCP probe. NetScaler provides support for external TCP
health check of the vserver status over the selected port. This option is only supported
for vservers assigned with an IPAddress or ipset.
type: int
useportrange:
choices:
- 'ON'
- 'OFF'
description:
- Use a port number from the port range (set by using the set ns param command, or
in the Create Virtual Server (Cache Redirection) dialog box) as the source port
in the requests sent to the origin server.
type: str
backupvserver:
description:
- Name of the backup virtual server to which traffic is forwarded if the active server
becomes unavailable.
type: str
onpolicymatch:
choices:
- CACHE
- ORIGIN
description:
- Redirect requests that match the policy to either the cache or the origin server,
as specified.
- 'Note: For this option to work, you must set the cache redirection type to POLICY.'
type: str
probeprotocol:
choices:
- TCP
- HTTP
description:
- Citrix ADC provides support for external health check of the vserver status. Select
C(HTTP) or C(TCP) probes for healthcheck
type: str
dnsvservername:
description:
- Name of the DNS virtual server that resolves domain names arriving at the forward
proxy virtual server.
- 'Note: This parameter applies only to forward proxy virtual servers, not reverse
or transparent.'
type: str
downstateflush:
choices:
- ENABLED
- DISABLED
description:
- Perform delayed cleanup of connections to this virtual server.
type: str
listenpriority:
description:
- Priority of the listen policy specified by the Listen Policy parameter. The lower
the number, higher the priority.
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 profile containing TCP configuration information for the cache redirection
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 profile containing HTTP configuration information for cache redirection
virtual server.
type: str
icmpvsrresponse:
choices:
- PASSIVE
- ACTIVE
description:
- Criterion for responding to PING requests sent to this virtual server. If C(ACTIVE),
respond only if the virtual server is available. If C(PASSIVE), respond even if
the virtual server is not available.
type: str
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
destinationvserver:
description:
- Destination virtual server for a transparent or forward proxy cache redirection
virtual server.
type: str
disableprimaryondown:
choices:
- ENABLED
- DISABLED
description:
- Continue sending traffic to a backup virtual server even after the primary virtual
server comes UP from the DOWN state.
type: str
sopersistencetimeout:
description:
- Time-out, in minutes, for spillover persistence.
type: float
disallowserviceaccess:
choices:
- ENABLED
- DISABLED
description:
- This is effective when a FORWARD type cr vserver is added. By default, this parameter
is C(DISABLED). When it is C(ENABLED), backend services cannot be accessed through
a FORWARD type cr vserver.
type: str
useoriginipportforcache:
choices:
- 'YES'
- 'NO'
description:
- Use origin ip/port while forwarding request to the cache. Change the destination
IP, destination port of the request came to CR vserver to Origin IP and Origin Port
and forward it to Cache
type: str
probesuccessresponsecode:
description:
- HTTP code to return in SUCCESS case.
type: str
crvserver_crpolicy_binding:
description: Bindings for crvserver_crpolicy_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
crvserver_cspolicy_binding:
description: Bindings for crvserver_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
crvserver_cmppolicy_binding:
description: Bindings for crvserver_cmppolicy_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
crvserver_feopolicy_binding:
description: Bindings for crvserver_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
crvserver_icapolicy_binding:
description: Bindings for crvserver_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
crvserver_lbvserver_binding:
description: Bindings for crvserver_lbvserver_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
crvserver_policymap_binding:
description: Bindings for crvserver_policymap_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
crvserver_appfwpolicy_binding:
description: Bindings for crvserver_appfwpolicy_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
crvserver_cachepolicy_binding:
description: Bindings for crvserver_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
crvserver_appqoepolicy_binding:
description: Bindings for crvserver_appqoepolicy_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
crvserver_appflowpolicy_binding:
description: Bindings for crvserver_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
crvserver_rewritepolicy_binding:
description: Bindings for crvserver_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
crvserver_responderpolicy_binding:
description: Bindings for crvserver_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
crvserver_spilloverpolicy_binding:
description: Bindings for crvserver_spilloverpolicy_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
crvserver_analyticsprofile_binding:
description: Bindings for crvserver_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
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