Try SpotterBinding Resource definition for describing association between responderglobal and responderpolicy resources
| "added in version" 2.0.0 of netscaler.adc"
Authors: Sumanth Lingappa (@sumanth-lingappa)
preview | supported by community
Install with ansible-galaxy collection install netscaler.adc:==2.5.1
collections:
- name: netscaler.adc
version: 2.5.1Binding Resource definition for describing association between responderglobal and responderpolicy resources
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
type:
choices:
- REQ_OVERRIDE
- REQ_DEFAULT
- OVERRIDE
- DEFAULT
- OTHERTCP_REQ_OVERRIDE
- OTHERTCP_REQ_DEFAULT
- SIPUDP_REQ_OVERRIDE
- SIPUDP_REQ_DEFAULT
- SIPTCP_REQ_OVERRIDE
- SIPTCP_REQ_DEFAULT
- MSSQL_REQ_OVERRIDE
- MSSQL_REQ_DEFAULT
- MYSQL_REQ_OVERRIDE
- MYSQL_REQ_DEFAULT
- NAT_REQ_OVERRIDE
- NAT_REQ_DEFAULT
- DIAMETER_REQ_OVERRIDE
- DIAMETER_REQ_DEFAULT
- RADIUS_REQ_OVERRIDE
- RADIUS_REQ_DEFAULT
- DNS_REQ_OVERRIDE
- DNS_REQ_DEFAULT
- MQTT_REQ_OVERRIDE
- MQTT_REQ_DEFAULT
- MQTT_JUMBO_REQ_OVERRIDE
- MQTT_JUMBO_REQ_DEFAULT
- QUIC_OVERRIDE
- QUIC_DEFAULT
- HTTPQUIC_REQ_OVERRIDE
- HTTPQUIC_REQ_DEFAULT
description:
- 'Specifies the bind point whose policies you want to display. Available settings
function as follows:'
- '* C(REQ_OVERRIDE) - Request override. Binds the policy to the priority request
queue.'
- '* C(REQ_DEFAULT) - Binds the policy to the default request queue.'
- '* C(OTHERTCP_REQ_OVERRIDE) - Binds the policy to the non-HTTP TCP priority request
queue.'
- '* C(OTHERTCP_REQ_DEFAULT) - Binds the policy to the non-HTTP TCP default request
queue..'
- '* C(SIPUDP_REQ_OVERRIDE) - Binds the policy to the SIP UDP priority response queue..'
- '* C(SIPUDP_REQ_DEFAULT) - Binds the policy to the SIP UDP default response queue.'
- '* C(RADIUS_REQ_OVERRIDE) - Binds the policy to the RADIUS priority response queue..'
- '* C(RADIUS_REQ_DEFAULT) - Binds the policy to the RADIUS default response queue.'
- '* C(MSSQL_REQ_OVERRIDE) - Binds the policy to the Microsoft SQL priority response
queue..'
- '* C(MSSQL_REQ_DEFAULT) - Binds the policy to the Microsoft SQL default response
queue.'
- '* C(MYSQL_REQ_OVERRIDE) - Binds the policy to the MySQL priority response queue.'
- '* C(MYSQL_REQ_DEFAULT) - Binds the policy to the MySQL default response queue.'
- '* C(HTTPQUIC_REQ_OVERRIDE) - Binds the policy to the HTTP_QUIC override response
queue.'
- '* C(HTTPQUIC_REQ_DEFAULT) - Binds the policy to the HTTP_QUIC default response
queue.'
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
invoke:
description:
- If the current policy evaluates to TRUE, terminate evaluation of policies bound
to the current policy label, and then forward the request to the specified virtual
server or evaluate the specified 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:
- Specifies the priority of the policy.
type: float
labelname:
description:
- Name of the policy label to invoke. If the current policy evaluates to TRUE, the
invoke parameter is set, and Label Type is policylabel.
type: str
labeltype:
choices:
- vserver
- policylabel
description:
- 'Type of invocation, Available settings function as follows:'
- '* C(vserver) - Forward the request to the specified virtual server.'
- '* C(policylabel) - Invoke the specified 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
policyname:
description:
- Name of the responder policy.
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
globalbindtype:
choices:
- SYSTEM_GLOBAL
- VPN_GLOBAL
- RNAT_GLOBAL
- APPFW_GLOBAL
description:
- '0'
type: str
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
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