Try SpotterConfiguration for ip 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 ip resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | nsip
delegate_to: localhost
netscaler.adc.nsip:
state: present
ipaddress: 1.1.1.1
netmask: 255.255.255.192
type: VIP
- name: Sample Task | nsip | 2
delegate_to: localhost
netscaler.adc.nsip:
state: present
ipaddress: 192.188.1.1
netmask: 255.255.255.0
vserver: DISABLED
dynamicrouting: ENABLED
- name: Sample Task | nsip | 3
delegate_to: localhost
netscaler.adc.nsip:
state: present
ipaddress: 192.179.1.1
netmask: 255.255.255.255
type: VIP
arp: DISABLED
snmp: DISABLED
hostroute: ENABLED
hostrtgw: 0.0.0.0
- name: Sample Task | nsip | 4
delegate_to: localhost
netscaler.adc.nsip:
state: present
ipaddress: 192.188.1.2
netmask: 255.255.0.0
vserver: DISABLED
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. TD id 4095 is used reserved for LSN use
type: float
arp:
choices:
- ENABLED
- DISABLED
description:
- Respond to ARP requests for this IP address.
type: str
bgp:
choices:
- ENABLED
- DISABLED
description:
- Use this option to enable or disable BGP on this IP address for the entity.
type: str
ftp:
choices:
- ENABLED
- DISABLED
description:
- Allow File Transfer Protocol (FTP) access to this IP address.
type: str
gui:
choices:
- ENABLED
- SECUREONLY
- DISABLED
description:
- Allow graphical user interface (GUI) access to this IP address.
type: str
rip:
choices:
- ENABLED
- DISABLED
description:
- Use this option to enable or disable RIP on this IP address for the entity.
type: str
ssh:
choices:
- ENABLED
- DISABLED
description:
- Allow secure shell (SSH) access to this IP address.
type: str
tag:
description:
- Tag value for the network/host route associated with this IP.
type: float
icmp:
choices:
- ENABLED
- DISABLED
description:
- Respond to ICMP requests for this IP address.
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
ospf:
choices:
- ENABLED
- DISABLED
description:
- Use this option to enable or disable OSPF on this IP address for the entity.
type: str
snmp:
choices:
- ENABLED
- DISABLED
description:
- Allow Simple Network Management Protocol (SNMP) access to this IP address.
type: str
type:
choices:
- SNIP
- VIP
- NSIP
- HostIP
- GSLBsiteIP
- CLIP
description:
- 'Type of the IP address to create on the Citrix ADC. Cannot be changed after the
IP address is created. The following are the different types of Citrix ADC owned
IP addresses:'
- '* A Subnet IP (C(SNIP)) address is used by the Citrix ADC to communicate with the
servers. The Citrix ADC also uses the subnet IP address when generating its own
packets, such as packets related to dynamic routing protocols, or to send monitor
probes to check the health of the servers.'
- '* A Virtual IP (C(VIP)) address is the IP address associated with a virtual server.
It is the IP address to which clients connect. An appliance managing a wide range
of traffic may have many VIPs configured. Some of the attributes of the C(VIP) address
are customized to meet the requirements of the virtual server.'
- '* A GSLB site IP (GSLBIP) address is associated with a GSLB site. It is not mandatory
to specify a GSLBIP address when you initially configure the Citrix ADC. A GSLBIP
address is used only when you create a GSLB site.'
- '* A Cluster IP (C(CLIP)) address is the management address of the cluster. All
cluster configurations must be performed by accessing the cluster through this IP
address.'
type: str
vrid:
description:
- A positive integer that uniquely identifies a VMAC address for binding to this VIP
address. This binding is used to set up Citrix ADCs in an active-active configuration
using VRRP.
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
metric:
description:
- Integer value to add to or subtract from the cost of the route advertised for the
VIP address.
type: int
telnet:
choices:
- ENABLED
- DISABLED
description:
- Allow Telnet access to this IP address.
type: str
netmask:
description:
- Subnet mask associated with the IP address.
type: str
vserver:
choices:
- ENABLED
- DISABLED
description:
- Use this option to set (enable or disable) the virtual server attribute for this
IP address.
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
arpowner:
description:
- The arp owner in a Cluster for this IP address. It can vary from 0 to 31.
type: float
hostrtgw:
description:
- IP address of the gateway of the route for this VIP address.
type: str
ospfarea:
description:
- ID of the area in which the type1 link-state advertisements (LSAs) are to be advertised
for this virtual IP (VIP) address by the OSPF protocol running on the Citrix ADC. When
this parameter is not set, the VIP is advertised on all areas.
type: float
hostroute:
choices:
- ENABLED
- DISABLED
description:
- Option to push the VIP to ZebOS routing table for Kernel route redistribution through
dynamic routing protocols
type: str
ipaddress:
description:
- IPv4 address to create on the Citrix ADC. Cannot be changed after the IP address
is created.
type: str
ownernode:
description:
- The owner node in a Cluster for this IP address. Owner node can vary from 0 to 31.
If ownernode is not specified then the IP is treated as Striped IP.
type: float
mgmtaccess:
choices:
- ENABLED
- DISABLED
description:
- Allow access to management applications on this IP address.
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
arpresponse:
choices:
- NONE
- ONE_VSERVER
- ALL_VSERVERS
description:
- 'Respond to ARP requests for a Virtual IP (VIP) address on the basis of the states
of the virtual servers associated with that VIP. Available settings function as
follows:'
- ''
- '* C(NONE) - The Citrix ADC responds to any ARP request for the VIP address, irrespective
of the states of the virtual servers associated with the address.'
- '* ONE VSERVER - The Citrix ADC responds to any ARP request for the VIP address
if at least one of the associated virtual servers is in UP state.'
- '* ALL VSERVER - The Citrix ADC responds to any ARP request for the VIP address
if all of the associated virtual servers are in UP state.'
type: str
ospflsatype:
choices:
- TYPE1
- TYPE5
description:
- Type of LSAs to be used by the OSPF protocol, running on the Citrix ADC, for advertising
the route for this VIP address.
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
decrementttl:
choices:
- ENABLED
- DISABLED
description:
- Decrement TTL by 1 when C(ENABLED).This setting is applicable only for UDP traffic.
type: str
icmpresponse:
choices:
- NONE
- ONE_VSERVER
- ALL_VSERVERS
- VSVR_CNTRLD
description:
- 'Respond to ICMP requests for a Virtual IP (VIP) address on the basis of the states
of the virtual servers associated with that VIP. Available settings function as
follows:'
- '* C(NONE) - The Citrix ADC responds to any ICMP request for the VIP address, irrespective
of the states of the virtual servers associated with the address.'
- '* ONE VSERVER - The Citrix ADC responds to any ICMP request for the VIP address
if at least one of the associated virtual servers is in UP state.'
- '* ALL VSERVER - The Citrix ADC responds to any ICMP request for the VIP address
if all of the associated virtual servers are in UP state.'
- '* C(VSVR_CNTRLD) - The behavior depends on the ICMP VSERVER RESPONSE setting on
all the associated virtual servers.'
- ''
- 'The following settings can be made for the ICMP VSERVER RESPONSE parameter on a
virtual server:'
- '* If you set ICMP VSERVER RESPONSE to PASSIVE on all virtual servers, Citrix ADC
always responds.'
- '* If you set ICMP VSERVER RESPONSE to ACTIVE on all virtual servers, Citrix ADC
responds if even one virtual server is UP.'
- '* When you set ICMP VSERVER RESPONSE to ACTIVE on some and PASSIVE on others, Citrix
ADC responds if even one virtual server set to ACTIVE is UP.'
type: str
networkroute:
choices:
- ENABLED
- DISABLED
description:
- Option to push the SNIP subnet to ZebOS routing table for Kernel route redistribution
through dynamic routing protocol.
type: str
dynamicrouting:
choices:
- ENABLED
- DISABLED
description:
- Allow dynamic routing on this IP address. Specific to Subnet IP (SNIP) address.
type: str
mptcpadvertise:
choices:
- 'YES'
- 'NO'
description:
- If enabled, this IP will be advertised by Citrix ADC to MPTCP enabled clients as
part of ADD_ADDR option.
type: str
nitro_protocol:
choices:
- http
- https
default: https
description:
- Which protocol to use when accessing the nitro API objects.
type: str
restrictaccess:
choices:
- ENABLED
- DISABLED
description:
- Block access to nonmanagement applications on this IP. This option is applicable
for MIPs, SNIPs, and NSIP, and is disabled by default. Nonmanagement applications
can run on the underlying Citrix ADC Free BSD operating system.
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
vserverrhilevel:
choices:
- ONE_VSERVER
- ALL_VSERVERS
- NONE
- VSVR_CNTRLD
description:
- Advertise the route for the Virtual IP (VIP) address on the basis of the state of
the virtual servers associated with that VIP.
- '* C(NONE) - Advertise the route for the VIP address, regardless of the state of
the virtual servers associated with the address.'
- '* ONE VSERVER - Advertise the route for the VIP address if at least one of the
associated virtual servers is in UP state.'
- '* ALL VSERVER - Advertise the route for the VIP address if all of the associated
virtual servers are in UP state.'
- '* C(VSVR_CNTRLD) - Advertise the route for the VIP address according to the RHIstate
(RHI STATE) parameter setting on all the associated virtual servers of the VIP address
along with their states.'
- ''
- 'When Vserver RHI Level (RHI) parameter is set to C(VSVR_CNTRLD), the following
are different RHI behaviors for the VIP address on the basis of RHIstate (RHI STATE)
settings on the virtual servers associated with the VIP address:'
- ' * If you set RHI STATE to PASSIVE on all virtual servers, the Citrix ADC always
advertises the route for the VIP address.'
- ' * If you set RHI STATE to ACTIVE on all virtual servers, the Citrix ADC advertises
the route for the VIP address if at least one of the associated virtual servers
is in UP state.'
- ' *If you set RHI STATE to ACTIVE on some and PASSIVE on others, the Citrix ADC
advertises the route for the VIP address if at least one of the associated virtual
servers, whose RHI STATE set to ACTIVE, is in UP state.'
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
ownerdownresponse:
choices:
- 'YES'
- 'NO'
description:
- in cluster system, if the owner node is down, whether should it respond to icmp/arp
type: str
advertiseondefaultpartition:
choices:
- ENABLED
- DISABLED
description:
- Advertise VIPs from Shared VLAN on Default Partition.
type: str
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