netscaler.adc.gslbvserver_domain_binding (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

Binding Resource definition for describing association between gslbvserver and domain resources

Inputs

    
ttl:
    description:
    - Time to live (TTL) for the domain.
    type: float

name:
    description:
    - Name of the virtual server on which to perform the binding operation.
    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

order:
    description:
    - Order number to be assigned to the service when it is bound to the lb vserver.
    type: float

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

backupip:
    description:
    - The IP address of the backup service for the specified domain name. Used when all
      the services bound to the domain are down, or when the backup chain of virtual servers
      is down.
    type: str

domainname:
    description:
    - Domain name for which to change the time to live (TTL) and/or backup service IP
      address.
    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

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

backupipflag:
    description:
    - The IP address of the backup service for the specified domain name. Used when all
      the services bound to the domain are down, or when the backup chain of virtual servers
      is down.
    type: bool

cookie_domain:
    description:
    - The cookie domain for the GSLB site. Used when inserting the GSLB site cookie in
      the HTTP response.
    type: str

cookietimeout:
    description:
    - Timeout, in minutes, for the GSLB site cookie.
    type: float

sitedomainttl:
    description:
    - TTL, in seconds, for all internally created site domains (created when a site prefix
      is configured on a GSLB service) that are associated with this virtual server.
    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

cookie_domainflag:
    description:
    - The cookie domain for the GSLB site. Used when inserting the GSLB site cookie in
      the HTTP response.
    type: bool

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