netscaler.adc.gslbparameter (2.5.1) — module

Configuration for GSLB parameter resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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

state:
    choices:
    - present
    - 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(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

ldnsmask:
    description:
    - The IPv4 network mask with which to create LDNS entries.
    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

dropldnsreq:
    choices:
    - ENABLED
    - DISABLED
    description:
    - Drop LDNS requests if round-trip time (RTT) information is not available.
    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

undefaction:
    description:
    - 'Action to perform when policy evaluation creates an UNDEF condition. Available
      settings function as follows:'
    - '* NOLBACTION - Does not consider LB action in making LB decision.'
    - '* RESET - Reset the request and notify the user, so that the user can resend the
      request.'
    - '* DROP - Drop the request without sending a response to the user.'
    type: str

gslbsyncmode:
    choices:
    - IncrementalSync
    - FullSync
    description:
    - Mode in which configuration will be synced from master site to remote sites.
    type: str

rtttolerance:
    description:
    - Tolerance, in milliseconds, for newly learned round-trip time (RTT) values. If the
      difference between the old RTT value and the newly computed RTT value is less than
      or equal to the specified tolerance value, the LDNS entry in the network metric
      table is not updated with the new RTT value. Prevents the exchange of metrics when
      variations in RTT values are negligible.
    type: float

v6ldnsmasklen:
    description:
    - Mask for creating LDNS entries for IPv6 source addresses. The mask is defined as
      the number of leading bits to consider, in the source IP address, when creating
      an LDNS entry.
    type: float

ldnsprobeorder:
    choices:
    - PING
    - DNS
    - TCP
    description:
    - Order in which monitors should be initiated to calculate RTT.
    elements: str
    type: list

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

gslbsyncinterval:
    description:
    - Time duartion (in seconds) for which the gslb sync process will wait before checking
      for config changes.
    type: float

gslbsynclocfiles:
    choices:
    - ENABLED
    - DISABLED
    description:
    - If disabled, Location files will not be synced to the remote sites as part of automatic
      sync.
    type: str

ldnsentrytimeout:
    description:
    - Time, in seconds, after which an inactive LDNS entry is removed.
    type: float

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

automaticconfigsync:
    choices:
    - ENABLED
    - DISABLED
    description:
    - GSLB configuration will be synced automatically to remote gslb sites if enabled.
    type: str

mepkeepalivetimeout:
    description:
    - Time duartion (in seconds) during which if no new packets received by Local gslb
      site from Remote gslb site then mark the MEP connection DOWN
    type: float

svcstatelearningtime:
    description:
    - Time (in seconds) within which local or child site services remain in learning phase.
      GSLB site will enter the learning phase after reboot, HA failover, Cluster GSLB
      owner node changes or MEP being enabled on local node.  Backup parent (if configured)
      will selectively move the adopted children's GSLB services to learning phase when
      primary parent goes down. While a service is in learning period, remote site will
      not honour the state and stats got through MEP for that service. State can be learnt
      from health monitor if bound explicitly.
    type: float

gslbconfigsyncmonitor:
    choices:
    - ENABLED
    - DISABLED
    description:
    - If enabled, remote gslb site's rsync port will be monitored and site is considered
      for configuration sync only when the monitor is successful.
    type: str

gslbsvcstatedelaytime:
    description:
    - Amount of delay in updating the state of GSLB service to DOWN when MEP goes down.
    - "\t\t\tThis parameter is applicable only if monitors are not bound to GSLB services"
    type: float

gslbsyncsaveconfigcommand:
    choices:
    - ENABLED
    - DISABLED
    description:
    - If enabled, 'save ns config' command will be treated as other GSLB commands and
      synced to GSLB nodes when auto gslb sync option is enabled.
    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