| orphan: |
|---|
.. versionadded:: 1.0.0
- Manage service configuration in Citrix ADC.
- This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual Citrix ADC instance.
| Parameter | Choices/Defaults | Comment |
|---|---|---|
Internal (bool) |
Display only dynamically learned services. | |
accessdown (bool) |
Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service DOWN, and this parameter is disabled, the packets are dropped. | |
all (bool) |
Display both user-configured and dynamically learned services. | |
api_path (str) |
Base NITRO API path. Define only in case of an ADM service proxy call |
|
appflowlog (str) |
Choices:
|
Enable logging of AppFlow information. |
bearer_token (str) |
Authentication bearer token. Needed when doing an ADM service proxy call. |
|
cacheable (bool) |
Use the transparent cache redirection virtual server to forward requests to the cache server. Note: Do not specify this parameter if you set the Cache Type parameter. |
|
cachetype (str) |
Choices:
|
Cache type supported by the cache server. |
cip (str) |
Choices:
|
Before forwarding a request to the service, insert an HTTP header with the client's IPv4 or IPv6 as its value. Used if the server needs the client's IP address for security, accounting, or other and setting the Use Source IP parameter is not a viable option. |
cipheader (str) |
Name for the HTTP header whose value must be set to the IP address of the client. Used with the IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not the appliance inserts a header with the name "client-ip.". Minimum length = 1 |
|
cka (bool) |
Enable client keep-alive for the service. | |
cleartextport (int) |
Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. to transparent SSL services. Minimum value = |
|
clttimeout (int) |
Time, in seconds, after which to terminate an idle client connection. Minimum value = Maximum value = |
|
cmp (bool) |
Enable compression for the service. | |
comment (str) |
Any information about the service. | |
contentinspectionprofilename (str) |
Name of the ContentInspection profile that contains IPS/IDS communication related setting for the Minimum length = 1 Maximum length = 127 |
|
customserverid (str) |
Unique identifier for the service. Used when the persistency type for the virtual server is set to Server ID. | |
delay (str) |
Time, in seconds, allocated to the Citrix ADC for a graceful shutdown of the service. During this new requests are sent to the service only for clients who already have persistent sessions on the Requests from new clients are load balanced among other available services. After the delay time no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE). | |
disabled (bool) |
Default: False |
When set to When set to |
dnsprofilename (str) |
Name of the DNS profile to be associated with the service. DNS profile properties will applied to the processed by a service. This parameter is valid only for ADNS and ADNS-TCP services. Minimum length = 1 Maximum length = 127 |
|
downstateflush (str) |
Choices:
|
Flush all active transactions associated with a service whose state transitions from UP to DOWN. Do enable this option for applications that must complete their transactions. |
graceful (bool) |
Shut down gracefully, not accepting any new connections, and disabling the service when all of its are closed. | |
hashid (str) |
A numerical identifier that can be used by hash based load balancing methods. Must be unique for each Minimum value = |
|
healthmonitor (bool) |
Monitor the health of this service. Available settings function as follows: YES - Send probes to check the health of the service. NO - Do not send probes to check the health of the service. With the NO option, the appliance shows service as UP at all times. |
|
httpprofilename (str) |
Name of the HTTP profile that contains HTTP configuration settings for the service. Minimum length = 1 Maximum length = 127 |
|
ignore_monitors (list) |
Default: ['tcp-default', 'ping-default', 'default-path-monitor'] |
A list of monitor names to ignore when syncing monitors for the service Used to ignore default monitors that cannot be unbound from the service |
instance_id (str) |
The id of the target Citrix ADC instance when issuing a Nitro request through a Citrix ADM proxy. | |
instance_ip (str) (added in 2.6.0) |
The target Citrix ADC instance ip address to which all underlying NITRO API calls will be proxied to. It is meaningful only when having set |
|
instance_name (str) |
The name of the target Citrix ADC instance when issuing a Nitro request through a Citrix ADM proxy. | |
ip (str) |
IP to assign to the service. Minimum length = 1 |
|
ipaddress (str) |
The new IP address of the service. | |
is_cloud (bool) |
Default: False |
When performing a Proxy API call with ADM service set this to true |
mas_proxy_call (bool) (added in 2.6.0) |
Default: False |
If true the underlying NITRO API calls made by the module will be proxied through a Citrix ADM node to the target Citrix ADC instance. When true you must also define the following options: When true and adm service is the api proxy the following option must also be defined: When true you must define a target ADC by defining any of the following parameters I(instance_ip) I(instance_id) I(instance_name) |
maxbandwidth (str) |
Maximum bandwidth, in Kbps, allocated to the service. Minimum value = Maximum value = |
|
maxclient (str) |
Maximum number of simultaneous open connections to the service. Minimum value = Maximum value = |
|
maxreq (str) |
Maximum number of requests that can be sent on a persistent connection to the service. Note: Connection requests beyond this value are rejected. Minimum value = Maximum value = |
|
monconnectionclose (str) |
Choices:
|
Close monitoring connections by sending the service a connection termination message with the bit set. |
monitor_bindings (list) |
A list of monitor to bind to the service | |
monitor_name_svc (str) |
Name of the monitor bound to the specified service. Minimum length = 1 |
|
monthreshold (str) |
Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to a service as UP or DOWN. Minimum value = Maximum value = |
|
name (str) |
Name for the service. Must begin with an ASCII alphabetic or underscore (_) character, and must only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and (-) characters. Cannot be changed after the service has been created. Minimum length = 1 |
|
netprofile (str) |
Network profile to use for the service. Minimum length = 1 Maximum length = 127 |
|
nitro_auth_token (str) (added in 2.6.0) |
The authentication token provided by a login operation. | |
nitro_pass (str) |
The password with which to authenticate to the Citrix ADC node. | |
nitro_protocol (str) |
Choices:
|
Which protocol to use when accessing the nitro API objects. |
nitro_timeout (float) |
Default: 310 |
Time in seconds until a timeout error is thrown when establishing a new session with Citrix ADC |
nitro_user (str) |
The username with which to authenticate to the Citrix ADC node. | |
nsip (str) |
The ip address of the Citrix 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. |
|
pathmonitor (bool) |
Path monitoring for clustering. | |
pathmonitorindv (bool) |
Individual Path monitoring decisions. | |
port (int) |
Port number of the service. Range 1 - 65535
|
|
processlocal (str) |
Choices:
|
By turning on this option packets destined to a service in a cluster will not under go any steering. this option for single packet request response mode or when the upstream device is performing a RSS for connection based distribution. |
riseapbrstatsmsgcode (int) |
The code indicating the rise apbr status. | |
rtspsessionidremap (bool) |
Enable RTSP session ID mapping for the service. | |
save_config (bool) |
Default: True |
If true the module will save the configuration on the Citrix ADC node if it makes any changes. The module will not save the configuration on the Citrix ADC node if it made no changes. |
sc (bool) |
State of SureConnect for the service. | |
serverid (str) |
The identifier for the service. This is used when the persistency type is set to Custom Server ID. | |
servername (str) |
Name of the server that hosts the service. Minimum length = 1 |
|
servicetype (str) |
Choices:
|
Protocol in which data is exchanged with the service. |
sp (bool) |
Enable surge protection for the service. | |
state (str) |
Choices:
|
The state of the resource being configured by the module on the Citrix ADC node. When present the resource will be created if needed and configured according to the module's parameters. When absent the resource will be deleted from the Citrix ADC node. |
svrtimeout (int) |
Time, in seconds, after which to terminate an idle server connection. Minimum value = Maximum value = |
|
tcpb (bool) |
Enable TCP buffering for the service. | |
tcpprofilename (str) |
Name of the TCP profile that contains TCP configuration settings for the service. Minimum length = 1 Maximum length = 127 |
|
td (str) |
Integer value that uniquely identifies the traffic domain in which you want to configure the entity. you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of Minimum value = Maximum value = |
|
useproxyport (bool) |
Use the proxy port as the source port when initiating connections with the server. With the NO the client-side connection port is used as the source port for the server-side connection. Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES. |
|
usip (bool) |
Use the client's IP address as the source IP address when initiating a connection to the server. When a service, if you do not set this parameter, the service inherits the global Use Source IP setting in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes Configure Modes dialog box). However, you can override this setting after you create the service. | |
validate_certs (bool) |
Default: yes |
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. |
weight (str) |
Weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its with the service determines how much the monitor contributes toward keeping the health of the service the value configured for the Monitor Threshold parameter. Minimum value = Maximum value = |
# Monitor monitor-1 must have been already setup
- name: Setup http service
gather_facts: False
delegate_to: localhost
citrix_adc_service:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
state: present
name: service-http-1
servicetype: HTTP
ipaddress: 10.78.0.1
port: 80
monitor_bindings:
- monitor-1
| Key | Returned | Description |
|---|---|---|
diff_list (list) |
always | A dictionary with a list of differences between the actual configured object and the configuration specified in the module |
loglines (list) |
always | list of logged messages by the module Sample: ['message 1', 'message 2'] |
msg (str) |
failure | Message detailing the failure reason Sample: Action does not exist |