netscaler.adc.gslbconfig (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 gslb config resource.

Inputs

    
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

debug:
    description:
    - Generate verbose output when synchronizing the GSLB sites. The Debug option generates
      more verbose output than the sync gslb config command in which the option is not
      used, and is useful for analyzing synchronization issues.
    type: bool

state:
    choices: []
    default: present
    description:
    - The state of the resource being configured by the module on the NetScaler ADC node.
    type: str

nowarn:
    description:
    - Suppress the warning and the confirmation prompt that are displayed before site
      synchronization begins. This option can be used in automation scripts that must
      not be interrupted by a prompt.
    type: bool

command:
    description:
    - Run the specified command on the master node and then on all the slave nodes. You
      cannot use this option with the force sync and preview options.
    type: str

preview:
    description:
    - Do not synchronize the GSLB sites, but display the commands that would be applied
      on the slave node upon synchronization. Mutually exclusive with the Save Configuration
      option.
    type: bool

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

forcesync:
    description:
    - Force synchronization of the specified site even if a dependent configuration on
      the remote site is preventing synchronization or if one or more GSLB entities on
      the remote site have the same name but are of a different type. You can specify
      either the name of the remote site that you want to synchronize with the local site,
      or you can specify All Sites in the configuration utility (the string all-sites
      in the CLI). If you specify All Sites, all the sites in the GSLB setup are synchronized
      with the site on the master node.
    - 'Note: If you select the Force Sync option, the synchronization starts without displaying
      the commands that are going to be executed.'
    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

saveconfig:
    description:
    - Save the configuration on all the nodes participating in the synchronization process,
      automatically. The master saves its configuration immediately before synchronization
      begins. Slave nodes save their configurations after the process of synchronization
      is complete. A slave node saves its configuration only if the configuration difference
      was successfully applied to it. Mutually exclusive with the Preview option.
    type: bool

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

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