netscaler.adc.lbvserver_transformpolicy_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 lbvserver and transformpolicy resources

Inputs

    
name:
    description:
    - Name for the virtual server. 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. Can
      be changed after the virtual server is created.
    - ''
    - 'CLI Users: If the name includes one or more spaces, enclose the name in double
      or single quotation marks (for example, "my vserver" or ''my vserver'').'
    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:
    - Integer specifying the order of the service. A larger number specifies a lower order.
      Defines the order of the service relative to the other services in the load balancing
      vserver's bindings. Determines the priority given to the service among all the services
      bound.
    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

invoke:
    description:
    - Invoke policies bound to a virtual server or policy label.
    type: bool

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

priority:
    description:
    - Priority.
    type: float

bindpoint:
    choices:
    - REQUEST
    - RESPONSE
    - MQTT_JUMBO_REQ
    description:
    - The bindpoint to which the policy is bound
    type: str

labelname:
    description:
    - Name of the label invoked.
    type: str

labeltype:
    choices:
    - reqvserver
    - resvserver
    - policylabel
    description:
    - The invocation type.
    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

policyname:
    description:
    - Name of the policy bound to the LB vserver.
    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

gotopriorityexpression:
    description:
    - Expression specifying the priority of the next policy which will get evaluated if
      the current policy rule evaluates to TRUE.
    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