netscaler.adc.gslbservicegroup_gslbservicegroupmember_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 gslbservicegroup and gslbservicegroupmember resources

Inputs

    
ip:
    description:
    - IP Address.
    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

port:
    description:
    - Server port number.
    type: int

order:
    description:
    - Order number to be assigned to the gslb servicegroup member
    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

hashid:
    description:
    - The hash identifier for the service. This must be unique for each service. This
      parameter is used by hash based load balancing methods.
    type: float

weight:
    description:
    - Weight to assign to the servers in the service group. Specifies the capacity of
      the servers relative to the other servers in the load balancing configuration. The
      higher the weight, the higher the percentage of requests sent to the service.
    type: float

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

publicip:
    description:
    - The public IP address that a NAT device translates to the GSLB service's private
      IP address. Optional.
    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

publicport:
    description:
    - The public port associated with the GSLB service's public IP address. The port is
      mapped to the service's private port number. Applicable to the local GSLB service.
      Optional.
    type: int

servername:
    description:
    - Name of the server to which to bind the service group.
    type: str

siteprefix:
    description:
    - The site's prefix string. When the GSLB service group is bound to a GSLB virtual
      server, a GSLB site domain is generated internally for each bound serviceitem-domain
      pair by concatenating the site prefix of the service item and the name of the domain.
      If the special string NONE is specified, the site-prefix string is unset. When implementing
      HTTP redirect site persistence, the Citrix ADC redirects GSLB requests to GSLB services
      by using their site domains.
    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

servicegroupname:
    description:
    - Name of the GSLB service group.
    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