netscaler.adc.lbpolicylabel (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 lb policy label 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
    - 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

comment:
    description:
    - Any comments to preserve information about this LB policy label.
    type: str

newname:
    description:
    - New name for the LB policy label. Must begin with a letter, number, or the underscore
      character (_), and must contain only letters, numbers, and the hyphen (-), period
      (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
    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

labelname:
    description:
    - Name for the LB policy label. Must begin with a letter, number, or the underscore
      character (_), and must contain only letters, numbers, and the hyphen (-), period
      (.) hash (#), space ( ), at (@), equals (=), colon (:), and underscore characters.
    - ''
    - 'The following requirement applies only to the Citrix ADC CLI:'
    - If the name includes one or more spaces, enclose the name in double or single quotation
      marks (for example, "my lb policy label" or 'my lb policy label').
    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

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

policylabeltype:
    choices:
    - HTTP
    - OTHERTCP
    - SIP_UDP
    - SIP_TCP
    - MYSQL
    - MSSQL
    - ORACLE
    - NAT
    - DIAMETER
    - RADIUS
    - DNS
    - MQTT
    - QUIC_BRIDGE
    - HTTP_QUIC
    description:
    - 'Protocols supported by the policylabel. Available Types are :'
    - '* C(HTTP) - C(HTTP) requests.'
    - '* C(DNS) - C(DNS) request.'
    - '* C(OTHERTCP) - C(OTHERTCP) request.'
    - '* C(SIP_UDP) - C(SIP_UDP) request.'
    - '* C(SIP_TCP) - C(SIP_TCP) request.'
    - '* C(MYSQL) - C(MYSQL) request.'
    - '* C(MSSQL) - C(MSSQL) request.'
    - '* C(ORACLE) - C(ORACLE) request.'
    - '* C(NAT) - C(NAT) request.'
    - '* C(DIAMETER) - C(DIAMETER) request.'
    - '* C(RADIUS) - C(RADIUS) request.'
    - '* C(MQTT) - C(MQTT) request.'
    - '* C(QUIC_BRIDGE) - C(QUIC_BRIDGE) request.'
    - '* C(HTTP_QUIC) - C(HTTP_QUIC) request.'
    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

lbpolicylabel_lbpolicy_binding:
    description: Bindings for lbpolicylabel_lbpolicy_binding resource
    suboptions:
      binding_members:
        default: []
        description: List of binding members
        elements: dict
        type: list
      mode:
        choices:
        - desired
        - bind
        - unbind
        default: desired
        description:
        - The mode in which to configure the bindings.
        - If mode is set to C(desired), the bindings will be added or removed from the
          target NetScaler ADCs as necessary to match the bindings specified in the state.
        - If mode is set to C(bind), the specified bindings will be added to the resource.
          The existing bindings in the target ADCs will not be modified.
        - If mode is set to C(unbind), the specified bindings will be removed from the
          resource. The existing bindings in the target ADCs will not be modified.
        type: str
    type: dict

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