netscaler.adc.responderglobal_responderpolicy_binding module – Binding Resource definition for describing association between responderglobal and responderpolicy resources

Note

This module is part of the netscaler.adc collection (version 2.6.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install netscaler.adc.

To use it in a playbook, specify: netscaler.adc.responderglobal_responderpolicy_binding.

New in netscaler.adc 2.0.0

Synopsis

  • Binding Resource definition for describing association between responderglobal and responderpolicy resources

Parameters

Parameter

Comments

api_path

string

Base NITRO API path.

Define only in case of an ADM service proxy call

Default: "nitro/v1/config"

globalbindtype

string

0

Choices:

  • "SYSTEM_GLOBAL"

  • "VPN_GLOBAL"

  • "RNAT_GLOBAL"

  • "APPFW_GLOBAL"

gotopriorityexpression

string

Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE.

invoke

boolean

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.

Choices:

  • false

  • true

labelname

string

Name of the policy label to invoke. If the current policy evaluates to TRUE, the invoke parameter is set, and Label Type is policylabel.

labeltype

string

Type of invocation, Available settings function as follows:

* vserver - Forward the request to the specified virtual server.

* policylabel - Invoke the specified policy label.

Choices:

  • "vserver"

  • "policylabel"

managed_netscaler_instance_id

string

added in netscaler.adc 2.6.0

The ID of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_ip

string

added in netscaler.adc 2.6.0

The IP of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_name

string

added in netscaler.adc 2.6.0

The name of the managed NetScaler instance to which NetScaler Console

has to configure as a proxy server.

Define only in case of an ADM service proxy call

managed_netscaler_instance_password

string

added in netscaler.adc 2.6.0

The password of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

managed_netscaler_instance_username

string

added in netscaler.adc 2.6.0

The username of the managed NetScaler instance.

Define only in case of an ADM service proxy call

In Settings > Administration > System Configurations > Basic Settings,

if you select Prompt Credentials for Instance Login,

ensure to configure username and password of a managed instance.

netscaler_console_as_proxy_server

boolean

added in netscaler.adc 2.6.0

The IP address of the NetScaler ADC appliance acting as a proxy server.

Define only in case of an ADM service proxy call

Choices:

  • false ← (default)

  • true

nitro_auth_token

string

The authentication token provided by a login operation.

nitro_pass

string

The password with which to authenticate to the NetScaler ADC node.

nitro_protocol

string

Which protocol to use when accessing the nitro API objects.

Choices:

  • "http"

  • "https" ← (default)

nitro_user

string

The username with which to authenticate to the NetScaler ADC node.

nsip

string / required

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.

policyname

string

Name of the responder policy.

priority

float

Specifies the priority of the policy.

save_config

boolean

If 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.

Choices:

  • false ← (default)

  • true

state

string

The state of the resource being configured by the module on the NetScaler ADC node.

When present, the resource will be added/updated configured according to the module’s parameters.

When absent, the resource will be deleted from the NetScaler ADC node.

Choices:

  • "present" ← (default)

  • "absent"

type

string

Specifies the bind point whose policies you want to display. Available settings function as follows:

* REQ_OVERRIDE - Request override. Binds the policy to the priority request queue.

* REQ_DEFAULT - Binds the policy to the default request queue.

* OTHERTCP_REQ_OVERRIDE - Binds the policy to the non-HTTP TCP priority request queue.

* OTHERTCP_REQ_DEFAULT - Binds the policy to the non-HTTP TCP default request queue..

* SIPUDP_REQ_OVERRIDE - Binds the policy to the SIP UDP priority response queue..

* SIPUDP_REQ_DEFAULT - Binds the policy to the SIP UDP default response queue.

* RADIUS_REQ_OVERRIDE - Binds the policy to the RADIUS priority response queue..

* RADIUS_REQ_DEFAULT - Binds the policy to the RADIUS default response queue.

* MSSQL_REQ_OVERRIDE - Binds the policy to the Microsoft SQL priority response queue..

* MSSQL_REQ_DEFAULT - Binds the policy to the Microsoft SQL default response queue.

* MYSQL_REQ_OVERRIDE - Binds the policy to the MySQL priority response queue.

* MYSQL_REQ_DEFAULT - Binds the policy to the MySQL default response queue.

* HTTPQUIC_REQ_OVERRIDE - Binds the policy to the HTTP_QUIC override response queue.

* HTTPQUIC_REQ_DEFAULT - Binds the policy to the HTTP_QUIC default response queue.

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"

validate_certs

boolean

If false, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates.

Choices:

  • false

  • true ← (default)

Notes

Note

Examples

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Indicates if any change is made by the module

Returned: always

Sample: true

diff

dictionary

Dictionary of before and after changes

Returned: always

Sample: {"after": {"key2": "pqr"}, "before": {"key1": "xyz"}, "prepared": "changes done"}

diff_list

list / elements=string

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"]

failed

boolean

Indicates if the module failed or not

Returned: always

Sample: false

loglines

list / elements=string

list of logged messages by the module

Returned: always

Sample: ["message 1", "message 2"]

Authors

  • Sumanth Lingappa (@sumanth-lingappa)