netscaler.adc.clusterinstance (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for cluster instance resource.

Inputs

    
inc:
    choices:
    - ENABLED
    - DISABLED
    description:
    - This option is required if the cluster nodes reside on different networks.
    type: str

clid:
    description:
    - Unique number that identifies the cluster.
    type: float

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
    - 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

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    type: str

nodegroup:
    description:
    - The node group in a Cluster system used for transition from L2 to L3.
    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

preemption:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Preempt a cluster node that is configured as a SPARE if an ACTIVE node becomes available.
    type: str

quorumtype:
    choices:
    - MAJORITY
    - NONE
    description:
    - Quorum Configuration Choices  - "Majority" (recommended) requires majority of nodes
      to be online for the cluster to be UP. "None" relaxes this requirement.
    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

deadinterval:
    description:
    - Amount of time, in seconds, after which nodes that do not respond to the heartbeats
      are assumed to be down.If the value is less than 3 sec, set the helloInterval parameter
      to 200 msec
    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.
    type: str

hellointerval:
    description:
    - Interval, in milliseconds, at which heartbeats are sent to each cluster node to
      check the health status.Set the value to 200 msec, if the deadInterval parameter
      is less than 3 sec
    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

clusterproxyarp:
    choices:
    - ENABLED
    - DISABLED
    description:
    - This field controls the proxy arp feature in cluster. By default the flag is enabled.
    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

dfdretainl2params:
    choices:
    - ENABLED
    - DISABLED
    description:
    - flag to add ext l2 header during steering. By default the flag is disabled.
    type: str

backplanebasedview:
    choices:
    - ENABLED
    - DISABLED
    description:
    - View based on heartbeat only on bkplane interface
    type: str

syncstatusstrictmode:
    choices:
    - ENABLED
    - DISABLED
    description:
    - strict mode for sync status of cluster. Depending on the the mode if there are any
      errors while applying config, sync status is displayed accordingly. By default the
      flag is disabled.
    type: str

retainconnectionsoncluster:
    choices:
    - 'YES'
    - 'NO'
    description:
    - This option enables you to retain existing connections on a node joining a Cluster
      system or when a node is being configured for passive timeout. By default, this
      option is disabled.
    type: str

Outputs

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