Try SpotterConfiguration for node 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 node resource.
---
- name: Sample Playbook
hosts: localhost
gather_facts: false
tasks:
- name: Sample Task | HAnode
delegate_to: localhost
netscaler.adc.hanode:
state: present
id: 1
ipaddress: 10.10.10.141
id:
description:
- Number that uniquely identifies the node. For self node, it will always be 0. Peer
node values can range from 1-64.
type: float
inc:
choices:
- ENABLED
- DISABLED
description:
- 'This option is required if the HA nodes reside on different networks. When this
mode is enabled, the following independent network entities and configurations are
neither propagated nor synced to the other node: MIPs, SNIPs, VLANs, routes (except
LLB routes), route monitors, RNAT rules (except any RNAT rule with a VIP as the
NAT IP), and dynamic routing configurations. They are maintained independently on
each node.'
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
state:
choices:
- present
- absent
- 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(unset), the resource will be unset on the NetScaler ADC node.
type: str
haprop:
choices:
- ENABLED
- DISABLED
description:
- 'Automatically propagate all commands from the primary to the secondary node, except
the following:'
- '* All HA configuration related commands. For example, add ha node, set ha node,
and bind ha node.'
- '* All Interface related commands. For example, set interface and unset interface.'
- '* All channels related commands. For example, add channel, set channel, and bind
channel.'
- The propagated command is executed on the secondary node before it is executed on
the primary. If command propagation fails, or if command execution fails on the
secondary, the primary node executes the command and logs an error. Command propagation
uses port 3010.
- 'Note: After enabling propagation, run force synchronization on either node.'
type: str
hasync:
choices:
- ENABLED
- DISABLED
description:
- Automatically maintain synchronization by duplicating the configuration of the primary
node on the secondary node. This setting is not propagated. Automatic synchronization
requires that this setting be enabled (the default) on the current secondary node.
Synchronization uses TCP port 3010.
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
failsafe:
choices:
- 'ON'
- 'OFF'
description:
- Keep one node primary if both nodes fail the health check, so that a partially available
node can back up data and handle traffic. This mode is set independently on each
node.
type: str
hastatus:
choices:
- ENABLED
- STAYSECONDARY
- DISABLED
- STAYPRIMARY
description:
- The HA status of the node. The HA status C(STAYSECONDARY) is used to force the secondary
device stay as secondary independent of the state of the Primary device. For example,
in an existing HA setup, the Primary node has to be upgraded and this process would
take few seconds. During the upgradation, it is possible that the Primary node may
suffer from a downtime for a few seconds. However, the Secondary should not take
over as the Primary node. Thus, the Secondary node should remain as Secondary even
if there is a failure in the Primary node.
- "\t C(STAYPRIMARY) configuration keeps the node in primary state in case if it is\
\ healthy, even if the peer node was the primary node initially. If the node with\
\ C(STAYPRIMARY) setting (and no peer node) is added to a primary node (which has\
\ this node as the peer) then this node takes over as the new primary and the older\
\ node becomes secondary. C(ENABLED) state means normal HA operation without any\
\ constraints/preferences. C(DISABLED) state disables the normal HA operation of\
\ the node."
type: str
maxflips:
description:
- Max number of flips allowed before becoming sticky primary
type: float
syncvlan:
description:
- Vlan on which HA related communication is sent. This include sync, propagation ,
connection mirroring , LB persistency config sync, persistent session sync and session
state sync. However HA heartbeats can go all interfaces.
type: float
ipaddress:
description:
- The NSIP or NSIP6 address of the node to be added for an HA configuration. This
setting is neither propagated nor synchronized.
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
maxfliptime:
description:
- Interval after which flipping of node states can again start
type: float
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
deadinterval:
description:
- Number of seconds after which a peer node is marked DOWN if heartbeat messages are
not received from the peer node.
type: float
hellointerval:
description:
- Interval, in milliseconds, between heartbeat messages sent to the peer node. The
heartbeat messages are UDP packets sent to port 3003 of the peer node.
type: float
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
nitro_auth_token:
description:
- The authentication token provided by a login operation.
type: str
version_added: 2.6.0
version_added_collection: netscaler.adc
syncstatusstrictmode:
choices:
- ENABLED
- DISABLED
description:
- strict mode flag for sync status
type: str
hanode_routemonitor_binding:
description: Bindings for hanode_routemonitor_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
hanode_routemonitor6_binding:
description: Bindings for hanode_routemonitor6_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