Try SpotterConfiguration for 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 server resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | server
delegate_to: localhost
netscaler.adc.server:
state: present
name: 10.10.10.10
ipaddress: 10.10.10.10
- name: Sample Task | server 2
delegate_to: localhost
tags: test
netscaler.adc.server:
state: present
domain: test.ap-southeast-1.example.com
name: test.ap-southeast-1.example.com
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
name:
description:
- Name for the server.
- 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.
- Can be changed after the name is 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
delay:
description:
- Time, in seconds, after which all the services configured on the server are disabled.
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
domain:
description:
- Domain name of the server. For a domain based configuration, you must create the
server first.
type: str
comment:
description:
- Any information about the server.
type: str
newname:
description:
- New name for the server. 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, without accepting any new connections, and disabling each
service when all of its connections are closed.
type: str
internal:
description:
- Display names of the servers that have been created for internal use.
type: bool
ipaddress:
description:
- 'IPv4 or IPv6 address of the server. If you create an IP address based server, you
can specify the name of the server, instead of its IP address, when creating a service.
Note: If you do not create a server entry, the server IP address that you enter
when you create a service becomes the name of the server.'
type: str
querytype:
choices:
- A
- AAAA
- SRV
description:
- Specify the type of DNS resolution to be done on the configured domain to get the
backend services. Valid query types are C(A), C(AAAA) and C(SRV) with C(A) being
the default querytype. The type of DNS resolution done on the domains in C(SRV)
records is inherited from ipv6 argument.
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
ipv6address:
choices:
- 'YES'
- 'NO'
description:
- Support IPv6 addressing mode. If you configure a server with the IPv6 addressing
mode, you cannot use the server in the IPv4 addressing mode.
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
translationip:
description:
- IP address used to transform the server's DNS-resolved IP address.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
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
translationmask:
description:
- The netmask of the translation ip
type: str
domainresolvenow:
description:
- Immediately send a DNS query to resolve the server's domain name.
type: bool
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
domainresolveretry:
description:
- Time, in seconds, for which the Citrix ADC must wait, after DNS resolution fails,
before sending the next DNS query to resolve the domain name.
type: int
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