community.network.netscaler_service module – Manage service configuration in Netscaler
Note
This module is part of the community.network collection (version 5.0.3).
You might already have this collection installed if you are using the ansible
package.
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 community.network
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.netscaler_service
.
Synopsis
Manage service configuration in Netscaler.
This module allows the creation, deletion and modification of Netscaler services.
This module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.
This module supports check mode.
Aliases: network.netscaler.netscaler_service
Requirements
The below requirements are needed on the host that executes this module.
nitro python sdk
Parameters
Parameter |
Comments |
---|---|
Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service is DOWN, and this parameter is disabled, the packets are dropped. Choices:
|
|
Enable logging of AppFlow information. Choices:
|
|
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. Choices:
|
|
Cache type supported by the cache server. Choices:
|
|
Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value. Used if the server needs the client’s IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option. Choices:
|
|
Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name “client-ip.”. Minimum length = 1 |
|
Enable client keep-alive for the service. Choices:
|
|
Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services. Minimum value = 1 |
|
Time, in seconds, after which to terminate an idle client connection. Minimum value = 0 Maximum value = 31536000 |
|
Enable compression for the service. Choices:
|
|
Any information about the service. |
|
Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID. Default: |
|
When set to When set to Note that due to limitations of the underlying NITRO API a Choices:
|
|
Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS and ADNS-TCP services. Minimum length = 1 Maximum length = 127 |
|
Flush all active transactions associated with a service whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions. Choices:
|
|
Shut down gracefully, not accepting any new connections, and disabling the service when all of its connections are closed. Choices:
|
|
A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service. Minimum value = 1 |
|
Monitor the health of this service Choices:
|
|
Name of the HTTP profile that contains HTTP configuration settings for the service. Minimum length = 1 Maximum length = 127 |
|
IP to assign to the service. Minimum length = 1 |
|
The new IP address of the service. |
|
Maximum bandwidth, in Kbps, allocated to the service. Minimum value = 0 Maximum value = 4294967287 |
|
Maximum number of simultaneous open connections to the service. Minimum value = 0 Maximum value = 4294967294 |
|
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 = 0 Maximum value = 65535 |
|
A list of load balancing monitors to bind to this service. Each monitor entry is a dictionary which may contain the following options. Note that if not using the built in monitors they must first be setup. |
|
State of the monitor. The state setting for a monitor of a given type affects all monitors of that type. For example, if an HTTP monitor is enabled, all HTTP monitors on the appliance are (or remain) enabled. If an HTTP monitor is disabled, all HTTP monitors on the appliance are disabled. Choices:
|
|
Weight to assign to the binding between the monitor and service. |
|
Name of the monitor. |
|
Weight to assign to the binding between the monitor and service. |
|
Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN. Minimum value = 0 Maximum value = 65535 |
|
Name for the service. Must begin with an ASCII alphabetic or underscore Minimum length = 1 |
|
Network profile to use for the service. Minimum length = 1 Maximum length = 127 |
|
The password with which to authenticate to the netscaler node. |
|
Which protocol to use when accessing the nitro API objects. Choices:
|
|
Time in seconds until a timeout error is thrown when establishing a new session with Netscaler Default: |
|
The username with which to authenticate to the netscaler node. |
|
The ip address of the netscaler appliance where the nitro API calls will be made. The port can be specified with the colon (:). E.g. 192.168.1.1:555. |
|
Path monitoring for clustering. |
|
Individual Path monitoring decisions. |
|
Port number of the service. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API |
|
By turning on this option packets destined to a service in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution. Choices:
|
|
Enable RTSP session ID mapping for the service. Choices:
|
|
If The module will not save the configuration on the netscaler node if it made no changes. Choices:
|
|
The identifier for the service. This is used when the persistency type is set to Custom Server ID. |
|
Name of the server that hosts the service. Minimum length = 1 |
|
Protocol in which data is exchanged with the service. Choices:
|
|
Enable surge protection for the service. Choices:
|
|
The state of the resource being configured by the module on the netscaler 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 netscaler node. Choices:
|
|
Time, in seconds, after which to terminate an idle server connection. Minimum value = 0 Maximum value = 31536000 |
|
Enable TCP buffering for the service. Choices:
|
|
Name of the TCP profile that contains TCP configuration settings for the service. Minimum length = 1 Maximum length = 127 |
|
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. Minimum value = 0 Maximum value = 4094 |
|
Use the proxy port as the source port when initiating connections with the server. With the NO setting, 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. Choices:
|
|
Use the client’s IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available 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. Choices:
|
|
If Choices:
|
Notes
Note
For more information on using Ansible to manage Citrix NetScaler Network devices see https://www.ansible.com/ansible-netscaler.
Examples
# Monitor monitor-1 must have been already setup
- name: Setup http service
gather_facts: false
delegate_to: localhost
community.network.netscaler_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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary with a list of differences between the actual configured object and the configuration specified in the module Returned: failure Sample: |
|
list of logged messages by the module Returned: always Sample: |