netscaler.adc.csvserver module – Configuration for CS virtual server resource.
Note
This module is part of the netscaler.adc collection (version 2.6.0).
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install netscaler.adc.
To use it in a playbook, specify: netscaler.adc.csvserver.
New in netscaler.adc 2.0.0
Synopsis
Configuration for CS virtual server resource.
Parameters
Parameter |
Comments |
|---|---|
Base NITRO API path. Define only in case of an ADM service proxy call Default: |
|
Enable logging appflow flow information Choices:
|
|
Authenticate users who request a connection to the content switching virtual server. Choices:
|
|
FQDN of the authentication virtual server. The service type of the virtual server should be either HTTP or SSL. |
|
Enable HTTP 401-response based authentication. Choices:
|
|
Name of the authentication profile to be used when authentication is turned on. |
|
Name of authentication virtual server that authenticates the incoming user requests to this content switching virtual server. |
|
0 |
|
Time period for which backup persistence is in effect. |
|
Name of the backup virtual server that you are configuring. 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 backup virtual server is created. You can assign a different backup virtual server or rename the existing virtual server. 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. |
|
Use this option to specify whether a virtual server, used for load balancing or content switching, routes requests to the cache redirection virtual server before sending it to the configured servers. Choices:
|
|
Consider case in URLs (for policies that use URLs instead of RULES). For example, with the Choices:
|
|
Idle time, in seconds, after which the client connection is terminated. The default values are: 180 seconds for HTTP/SSL-based services. 9000 seconds for other TCP-based services. 120 seconds for DNS-based services. 120 seconds for other UDP-based services. |
|
Information about this virtual server. |
|
0 |
|
Use this parameter to specify the cookie name for COOKIE peristence type. It specifies the name of cookie with a maximum of 32 characters. If not specified, cookie name is internally generated. |
|
0 |
|
Bindings for csvserver_analyticsprofile_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_appflowpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_appfwpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_appqoepolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_auditnslogpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_auditsyslogpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_authorizationpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_botpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_cachepolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_cmppolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_contentinspectionpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_cspolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_domain_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_feopolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_gslbvserver_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_lbvserver_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_responderpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_rewritepolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_spilloverpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_tmtrafficpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_transformpolicy_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Bindings for csvserver_vpnvserver_binding resource |
|
List of binding members Default: |
|
The mode in which to configure the bindings. If mode is set to If mode is set to If mode is set to Choices:
|
|
Name of the DB profile. |
|
Continue forwarding the traffic to backup virtual server even after the primary server comes UP from the DOWN state. Choices:
|
|
Name of the DNS profile to be associated with the VServer. DNS profile properties will applied to the transactions processed by a VServer. This parameter is valid only for DNS and DNS-TCP VServers. |
|
0 Choices:
|
|
Domain name for which to change the time to live (TTL) and/or backup service IP address. |
|
Flush all active transactions associated with a virtual server whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions. Choices:
|
|
This option starts/stops the dtls service on the vserver Choices:
|
|
Name of the HTTP profile containing HTTP configuration settings for the virtual server. The service type of the virtual server should be either HTTP or SSL. |
|
URL to which all HTTP traffic received on the port specified in the -redirectFromPort parameter is redirected. |
|
Can be active or passive Choices:
|
|
Insert the virtual server’s VIP address and port number in the request header. Available values function as follows:
Choices:
|
|
IP mask, in dotted decimal notation, for the IP Pattern parameter. Can have leading or trailing non-zero octets (for example, 255.255.240.0 or 0.0.255.255). Accordingly, the mask specifies whether the first n bits or the last n bits of the destination IP address in a client request are to be matched with the corresponding bits in the IP pattern. The former is called a forward mask. The latter is called a reverse mask. |
|
IP address pattern, in dotted decimal notation, for identifying packets to be accepted by the virtual server. The IP Mask parameter specifies which part of the destination IP address is matched against the pattern. Mutually exclusive with the IP Address parameter. For example, if the IP pattern assigned to the virtual server is 198.51.100.0 and the IP mask is 255.255.240.0 (a forward mask), the first 20 bits in the destination IP addresses are matched with the first 20 bits in the pattern. The virtual server accepts requests with IP addresses that range from 198.51.96.1 to 198.51.111.254. You can also use a pattern such as 0.0.2.2 and a mask such as 0.0.255.255 (a reverse mask). If a destination IP address matches more than one IP pattern, the pattern with the longest match is selected, and the associated virtual server processes the request. For example, if the virtual servers, vs1 and vs2, have the same IP pattern, 0.0.100.128, but different IP masks of 0.0.255.255 and 0.0.224.255, a destination IP address of 198.51.100.128 has the longest match with the IP pattern of vs1. If a destination IP address matches two or more virtual servers to the same extent, the request is processed by the virtual server whose port number matches the port number in the request. |
|
The list of IPv4/IPv6 addresses bound to ipset would form a part of listening service on the current cs vserver |
|
IP address of the content switching virtual server. |
|
Use L2 Parameters to identify a connection Choices:
|
|
String specifying the listen policy for the content switching virtual server. Can be either the name of an existing expression or an in-line expression. |
|
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. |
|
The ID of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call |
|
The IP of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call |
|
The name of the managed NetScaler instance to which NetScaler Console has to configure as a proxy server. Define only in case of an ADM service proxy call |
|
The password of the managed NetScaler instance. Define only in case of an ADM service proxy call In Settings > Administration > System Configurations > Basic Settings, if you select Prompt Credentials for Instance Login, ensure to configure username and password of a managed instance. |
|
The username of the managed NetScaler instance. Define only in case of an ADM service proxy call In Settings > Administration > System Configurations > Basic Settings, if you select Prompt Credentials for Instance Login, ensure to configure username and password of a managed instance. |
|
The version of the MSSQL server Choices:
|
|
The character set returned by the mysql vserver. |
|
The protocol version returned by the mysql vserver. |
|
The server capabilities returned by the mysql vserver. |
|
The server version string returned by the mysql vserver. |
|
Name for the content switching 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. Cannot be changed after the CS 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). |
|
The name of the network profile. |
|
The IP address of the NetScaler ADC appliance acting as a proxy server. Define only in case of an ADM service proxy call Choices:
|
|
New name for the 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. 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 name” or ‘my name’). |
|
The authentication token provided by a login operation. |
|
The password with which to authenticate to the NetScaler ADC node. |
|
Which protocol to use when accessing the nitro API objects. Choices:
|
|
The username with which to authenticate to the NetScaler ADC node. |
|
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. |
|
Oracle server version Choices:
|
|
Backup persistence type for the virtual server. Becomes operational if the primary persistence mechanism fails. Choices:
|
|
0 |
|
Type of persistence for the virtual server. Available settings function as follows: * * * Choices:
|
|
Persistence mask for IP based persistence types, for IPv4 virtual servers. |
|
Port number for content switching virtual server. |
|
Type of precedence to use for both Choices:
|
|
Citrix ADC provides support for external health check of the vserver status. Select port for HTTP/TCP monitring |
|
Citrix ADC provides support for external health check of the vserver status. Select Choices:
|
|
HTTP code to return in SUCCESS case. |
|
Process traffic with the push virtual server that is bound to this content switching virtual server (specified by the Push VServer parameter). The service type of the push virtual server should be either HTTP or SSL. Choices:
|
|
Expression for extracting the label from the response received from server. This string can be either an existing rule name or an inline expression. The service type of the virtual server should be either HTTP or SSL. |
|
Allow multiple Web 2.0 connections from the same client to connect to the virtual server and expect updates. Choices:
|
|
Name of the load balancing virtual server, of type PUSH or SSL_PUSH, to which the server pushes updates received on the client-facing load balancing virtual server. |
|
Name of QUIC profile which will be attached to the Content Switching VServer. |
|
Number of consecutive IP addresses, starting with the address specified by the IP Address parameter, to include in a range of addresses assigned to this virtual server. |
|
Port number for the virtual server, from which we absorb the traffic for http redirect |
|
State of port rewrite while performing HTTP redirect. Choices:
|
|
URL to which traffic is redirected if the virtual server becomes unavailable. The service type of the virtual server should be either HTTP or SSL. Caution: Make sure that the domain in the URL does not match the domain specified for a content switching policy. If it does, requests are continuously redirected to the unavailable virtual server. |
|
A host route is injected according to the setting on the virtual servers
Choices:
|
|
Enable network address translation (NAT) for real-time streaming protocol (RTSP) connections. Choices:
|
|
If The module will not save the configuration on the NetScaler ADC node if it made no changes. Choices:
|
|
Protocol used by the virtual server. Choices:
|
|
0 |
|
Action to be performed if spillover is to take effect, but no backup chain to spillover is usable or exists Choices:
|
|
Type of spillover used to divert traffic to the backup virtual server when the primary virtual server reaches the spillover threshold. Connection spillover is based on the number of connections. Bandwidth spillover is based on the total Kbps of incoming and outgoing traffic. Choices:
|
|
Maintain source-IP based persistence on primary and backup virtual servers. Choices:
|
|
Time-out value, in minutes, for spillover persistence. |
|
Depending on the spillover method, the maximum number of connections or the maximum total bandwidth (Kbps) that a virtual server can handle before spillover occurs. |
|
The state of the resource being configured by the module on the NetScaler ADC node. When When When When When Choices:
|
|
Enable state updates for a specific content switching virtual server. By default, the Content Switching virtual server is always UP, regardless of the state of the Load Balancing virtual servers bound to it. This parameter interacts with the global setting as follows: Global Level | Vserver Level | Result
If you want to enable state updates for only some content switching virtual servers, be sure to disable the state update parameter. Choices:
|
|
Virtual server target type. Choices:
|
|
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. |
|
Name of the TCP profile containing TCP configuration settings for the virtual server. |
|
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. |
|
Time period for which a persistence session is in effect. |
|
0 |
|
Persistence mask for IP based persistence types, for IPv6 virtual servers. |
|
If Choices:
|
|
Name of virtual server IP and port header, for use with the VServer IP Port Insertion parameter. |
Notes
Note
For more information on using Ansible to manage NetScaler ADC Network devices see https://www.ansible.com/integrations/networks/citrixadc.
Examples
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Set lb vserver 1
delegate_to: localhost
netscaler.adc.lbvserver:
# nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
# nitro_user: nitrouser # This can also be given via NETSCALER_NITRO_USER environment variable
# nitro_pass: verysecretpassword # This can also be given via NETSCALER_NITRO_PASS environment variable
# nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
# validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
# save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
state: present
name: lbvserver_1
servicetype: HTTP
ipv46: 10.78.1.1
port: 80
- name: Set cs policy
delegate_to: localhost
netscaler.adc.cspolicy:
# nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
# nitro_user: nitrouser # This can also be given via NETSCALER_NITRO_USER environment variable
# nitro_pass: verysecretpassword # This can also be given via NETSCALER_NITRO_PASS environment variable
# nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
# validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
# save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
state: present
policyname: policy_1
rule: "HTTP.REQ.URL.CONTAINS(\"/test\")"
- name: Set cs vserver
delegate_to: localhost
netscaler.adc.csvserver:
# nsip: 10.0.0.1 # This can also be given via NETSCALER_NSIP environment variable
# nitro_user: nitrouser # This can also be given via NETSCALER_NITRO_USER environment variable
# nitro_pass: verysecretpassword # This can also be given via NETSCALER_NITRO_PASS environment variable
# nitro_protocol: https # This can also be given via NETSCALER_NITRO_PROTOCOL environment variable
# validate_certs: false # This can also be given via NETSCALER_VALIDATE_CERTS environment variable
# save_config: false # This can also be given via NETSCALER_SAVE_CONFIG environment variable
state: present
name: cs-vserver-1
ipv46: 192.168.1.1
port: 90
servicetype: HTTP
csvserver_cspolicy_binding:
mode: desired
binding_members:
- name: cs-vserver-1
policyname: policy_1
targetlbvserver: lbvserver_1
priority: 1
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Indicates if any change is made by the module Returned: always Sample: |
|
Dictionary of before and after changes Returned: always Sample: |
|
List of differences between the actual configured object and the configuration specified in the module Returned: when changed Sample: |
|
Indicates if the module failed or not Returned: always Sample: |
|
list of logged messages by the module Returned: always Sample: |