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

newname:
    description:
    - The new name of the content switching policylabel.
    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 policy label. Must begin with an ASCII alphanumeric or underscore (_)
      character, and must contain only ASCII alphanumeric, underscore, hash (#), period
      (.), space, colon (:), at sign (@), equal sign (=), and hyphen (-) characters.
    - The label name must be unique within the list of policy labels for content switching.
    - '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 policylabel" or 'my policylabel').
    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

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

cspolicylabeltype:
    choices:
    - HTTP
    - TCP
    - RTSP
    - SSL
    - SSL_TCP
    - UDP
    - DNS
    - SIP_UDP
    - SIP_TCP
    - ANY
    - RADIUS
    - RDP
    - MYSQL
    - MSSQL
    - ORACLE
    - DIAMETER
    - SSL_DIAMETER
    - FTP
    - DNS_TCP
    - SMPP
    - MQTT
    - MQTT_TLS
    - HTTP_QUIC
    description:
    - 'Protocol supported by the policy label. All policies bound to the policy label
      must either match the specified protocol or be a subtype of that protocol. Available
      settings function as follows:'
    - '* C(HTTP) - Supports policies that process C(HTTP) traffic. Used to access unencrypted
      Web sites. (The default.)'
    - '* C(SSL) - Supports policies that process HTTPS/C(SSL) encrypted traffic. Used
      to access encrypted Web sites.'
    - '* C(TCP) - Supports policies that process any type of C(TCP) traffic, including
      C(HTTP).'
    - '* C(SSL_TCP) - Supports policies that process C(SSL)-encrypted C(TCP) traffic,
      including C(SSL).'
    - '* C(UDP) - Supports policies that process any type of C(UDP)-based traffic, including
      C(DNS).'
    - '* C(DNS) - Supports policies that process C(DNS) traffic.'
    - '* C(ANY) - Supports all types of policies except C(HTTP), C(SSL), and C(TCP).'
    - '* C(SIP_UDP) - Supports policies that process C(UDP) based Session Initiation Protocol
      (SIP) traffic. SIP initiates, manages, and terminates multimedia communications
      sessions, and has emerged as the standard for Internet telephony (VoIP).'
    - '* C(RTSP) - Supports policies that process Real Time Streaming Protocol (C(RTSP))
      traffic. C(RTSP) provides delivery of multimedia and other streaming data, such
      as audio, video, and other types of streamed media.'
    - '* C(RADIUS) - Supports policies that process Remote Authentication Dial In User
      Service (C(RADIUS)) traffic. C(RADIUS) supports combined authentication, authorization,
      and auditing services for network management.'
    - '* C(MYSQL) - Supports policies that process C(MYSQL) traffic.'
    - '* C(MSSQL) - Supports policies that process Microsoft SQL traffic.'
    type: str

cspolicylabel_cspolicy_binding:
    description: Bindings for cspolicylabel_cspolicy_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