Try SpotterConfiguration for service 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 service resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | service
delegate_to: localhost
netscaler.adc.service:
state: present
name: service-http
servicetype: HTTP
ipaddress: 172.18.0.4
port: 5000
- name: Sample Task | ipset-001
delegate_to: localhost
netscaler.adc.ipset:
state: present
name: ipset-001
- name: Sample Task | netProfile
delegate_to: localhost
netscaler.adc.netprofile:
state: present
name: test-netprofile
srcip: ipset-001
mbf: DISABLED
- name: Sample Task | lbmonitor | 3
delegate_to: localhost
tags: test
netscaler.adc.lbmonitor:
state: present
monitorname: test-monitor
type: TCP
interval: 15
retries: 20
- name: Setup services
delegate_to: localhost
tags: test
netscaler.adc.service:
state: present
name: 10.123.123.123-tcp-12345
servicetype: TCP
ipaddress: 10.123.123.123
port: 12345
healthmonitor: "NO"
netprofile: test-netprofile
service_lbmonitor_binding:
binding_members:
- monitor_name: test-monitor
name: 10.123.123.123-tcp-12345
ip:
description:
- IP to assign to the service.
type: str
sp:
choices:
- 'ON'
- 'OFF'
description:
- Enable surge protection for the service.
type: str
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
all:
description:
- Display both user-configured and dynamically learned services.
type: bool
cip:
choices:
- ENABLED
- DISABLED
description:
- 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.
type: str
cka:
choices:
- 'YES'
- 'NO'
description:
- Enable client keep-alive for the service.
type: str
cmp:
choices:
- 'YES'
- 'NO'
description:
- Enable compression for the service.
type: str
name:
description:
- Name for the service. 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. Cannot be changed after
the service has been created.
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 service.
type: int
tcpb:
choices:
- 'YES'
- 'NO'
description:
- Enable TCP buffering for the service.
type: str
usip:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
delay:
description:
- Time, in seconds, allocated to the Citrix ADC for a graceful shutdown of the service.
During this period, new requests are sent to the service only for clients who already
have persistent sessions on the appliance. Requests from new clients are load balanced
among other available services. After the delay time expires, no requests are sent
to the service, and the service is marked as unavailable (OUT OF SERVICE).
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
hashid:
description:
- A numerical identifier that can be used by hash based load balancing methods. Must
be unique for each service.
type: float
maxreq:
description:
- Maximum number of requests that can be sent on a persistent connection to the service.
- 'Note: Connection requests beyond this value are rejected.'
type: float
weight:
description:
- Weight to assign to the monitor-service binding. When a monitor is UP, the weight
assigned to its binding with the service determines how much the monitor contributes
toward keeping the health of the service above the value configured for the Monitor
Threshold parameter.
type: float
comment:
description:
- Any information about the service.
type: str
newname:
description:
- New name for the service. 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.
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
graceful:
choices:
- 'YES'
- 'NO'
description:
- Shut down gracefully, not accepting any new connections, and disabling the service
when all of its connections are closed.
type: str
internal:
description:
- Display only dynamically learned services.
type: bool
serverid:
description:
- The identifier for the service. This is used when the persistency type is set to
Custom Server ID.
type: float
cacheable:
choices:
- 'YES'
- 'NO'
description:
- 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.'
type: str
cachetype:
choices:
- TRANSPARENT
- REVERSE
- FORWARD
description:
- Cache type supported by the cache server.
type: str
cipheader:
description:
- 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."
type: str
ipaddress:
description:
- The new IP address of the service.
type: str
maxclient:
description:
- Maximum number of simultaneous open connections to the service.
type: float
accessdown:
choices:
- 'YES'
- 'NO'
description:
- 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.
type: str
appflowlog:
choices:
- ENABLED
- DISABLED
description:
- Enable logging of AppFlow information.
type: str
clttimeout:
description:
- Time, in seconds, after which to terminate an idle client connection.
type: float
netprofile:
description:
- Network profile to use for the service.
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
servername:
description:
- Name of the server that hosts the service.
type: str
svrtimeout:
description:
- Time, in seconds, after which to terminate an idle server connection.
type: float
pathmonitor:
choices:
- 'YES'
- 'NO'
description:
- Path monitoring for clustering
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
- FTP
- TCP
- UDP
- SSL
- SSL_BRIDGE
- SSL_TCP
- DTLS
- NNTP
- RPCSVR
- DNS
- ADNS
- SNMP
- RTSP
- DHCPRA
- ANY
- SIP_UDP
- SIP_TCP
- SIP_SSL
- DNS_TCP
- ADNS_TCP
- MYSQL
- MSSQL
- ORACLE
- MONGO
- MONGO_TLS
- RADIUS
- RADIUSListener
- RDP
- DIAMETER
- SSL_DIAMETER
- TFTP
- SMPP
- PPTP
- GRE
- SYSLOGTCP
- SYSLOGUDP
- FIX
- SSL_FIX
- USER_TCP
- USER_SSL_TCP
- QUIC
- IPFIX
- LOGSTREAM
- LOGSTREAM_SSL
- MQTT
- MQTT_TLS
- QUIC_BRIDGE
description:
- Protocol in which data is exchanged with the service.
type: str
maxbandwidth:
description:
- Maximum bandwidth, in Kbps, allocated to the service.
type: float
monthreshold:
description:
- 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.
type: float
processlocal:
choices:
- ENABLED
- DISABLED
description:
- 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.
type: str
useproxyport:
choices:
- 'YES'
- 'NO'
description:
- Use the proxy port as the source port when initiating connections with the server.
With the C(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 C(YES).'
type: str
cleartextport:
description:
- Port to which clear text data must be sent after the appliance decrypts incoming
SSL traffic. Applicable to transparent SSL services.
type: int
healthmonitor:
choices:
- 'YES'
- 'NO'
description:
- 'Monitor the health of this service. Available settings function as follows:'
- C(YES) - Send probes to check the health of the service.
- C(NO) - Do not send probes to check the health of the service. With the C(NO) option,
the appliance shows the service as UP at all times.
type: str
customserverid:
description:
- Unique identifier for the service. Used when the persistency type for the virtual
server is set to Custom Server ID.
type: str
dnsprofilename:
description:
- 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.
type: str
downstateflush:
choices:
- ENABLED
- DISABLED
description:
- 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.
type: str
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 that contains TCP configuration settings for the service.
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 that contains HTTP configuration settings for the service.
type: str
pathmonitorindv:
choices:
- 'YES'
- 'NO'
description:
- Individual Path monitoring decisions
type: str
monitor_name_svc:
description:
- Name of the monitor bound to the specified service.
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
monconnectionclose:
choices:
- RESET
- FIN
description:
- Close monitoring connections by sending the service a connection termination message
with the specified bit set.
type: str
rtspsessionidremap:
choices:
- 'ON'
- 'OFF'
description:
- Enable RTSP session ID mapping for the service.
type: str
service_lbmonitor_binding:
description: Bindings for service_lbmonitor_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
contentinspectionprofilename:
description:
- Name of the ContentInspection profile that contains IPS/IDS communication related
setting for the service
type: str
servicegroup_lbmonitor_binding:
description: Bindings for servicegroup_lbmonitor_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
servicegroup_servicegroupmember_binding:
description: Bindings for servicegroup_servicegroupmember_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