Try SpotterConfiguration for Virtual Router ID 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 Virtual Router ID resource.
id:
description:
- Integer that uniquely identifies the VMAC address. The generic VMAC address is in
the form of 00:00:5e:00:01:<VRID>. For example, if you add a VRID with a value of
60 and bind it to an interface, the resulting VMAC address is 00:00:5e:00:01:3c,
where 3c is the hexadecimal representation of 60.
type: float
all:
description:
- Remove all the configured VMAC addresses from the Citrix ADC.
type: bool
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
sharing:
choices:
- ENABLED
- DISABLED
description:
- In an active-active mode configuration, enable the backup VIP address to process
any traffic instead of dropping it.
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
priority:
description:
- Base priority (BP), in an active-active mode configuration, which ordinarily determines
the master VIP address.
type: float
tracking:
choices:
- NONE
- ONE
- ALL
- PROGRESSIVE
description:
- The effective priority (EP) value, relative to the base priority (BP) value in an
active-active mode configuration. When EP is set to a value other than None, it
is EP, not BP, which determines the master VIP address.
- 'Available settings function as follows:'
- '* C(NONE) - No tracking. EP = BP'
- '* C(ALL) - If the status of all virtual servers is UP, EP = BP. Otherwise, EP
= 0.'
- '* C(ONE) - If the status of at least one virtual server is UP, EP = BP. Otherwise,
EP = 0.'
- '* C(PROGRESSIVE) - If the status of all virtual servers is UP, EP = BP. If the
status of all virtual servers is DOWN, EP = 0. Otherwise EP = BP (1 - K/N), where
N is the total number of virtual servers associated with the VIP address and K is
the number of virtual servers for which the status is DOWN.'
- 'Default: C(NONE).'
type: str
ownernode:
description:
- In a cluster setup, assign a cluster node as the owner of this VMAC address for
IP based VRRP configuration. If no owner is configured, owner node is displayed
as ALL and one node is dynamically elected as the owner.
type: float
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
preemption:
choices:
- ENABLED
- DISABLED
description:
- In an active-active mode configuration, make a backup VIP address the master if
its priority becomes higher than that of a master VIP address bound to this VMAC
address.
- If you disable pre-emption while a backup VIP address is the master, the backup
VIP address remains master until the original master VIP's priority becomes higher
than that of the current master.
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
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
trackifnumpriority:
description:
- Priority by which the Effective priority will be reduced if any of the tracked interfaces
goes down in an active-active configuration.
type: float
preemptiondelaytimer:
description:
- Preemption delay time, in seconds, in an active-active configuration. If any high
priority node will come in network, it will wait for these many seconds before becoming
master.
type: float
vrid_channel_binding:
description: Bindings for vrid_channel_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
vrid6_channel_binding:
description: Bindings for vrid6_channel_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
vrid_interface_binding:
description: Bindings for vrid_interface_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
vrid6_interface_binding:
description: Bindings for vrid6_interface_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
vrid_trackinterface_binding:
description: Bindings for vrid_trackinterface_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
vrid6_trackinterface_binding:
description: Bindings for vrid6_trackinterface_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