netscaler.adc.csvserver_appqoepolicy_binding module – Binding Resource definition for describing association between csvserver and appqoepolicy 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.csvserver_appqoepolicy_binding
.
New in netscaler.adc 2.0.0
Synopsis
Binding Resource definition for describing association between csvserver and appqoepolicy resources
Parameters
Parameter |
Comments |
---|---|
Base NITRO API path. Define only in case of an ADM service proxy call Default: |
|
The bindpoint to which the policy is bound Choices:
|
|
Expression specifying the priority of the next policy which will get evaluated if the current policy rule evaluates to TRUE. |
|
Invoke flag. Choices:
|
|
Name of the label invoked. |
|
The invocation type. Choices:
|
|
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 |
|
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 |
|
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 |
|
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. |
|
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. |
|
Name of the content switching virtual server to which the content switching policy applies. |
|
The IP address of the NetScaler ADC appliance acting as a proxy server. Define only in case of an ADM service proxy call Choices:
|
|
The authentication token provided by a login operation. |
|
The password with which to authenticate to the NetScaler ADC node. |
|
Which protocol to use when accessing the nitro API objects. Choices:
|
|
The username with which to authenticate to the NetScaler ADC node. |
|
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. |
|
Policies bound to this vserver. |
|
Priority for the policy. |
|
If The module will not save the configuration on the NetScaler ADC node if it made no changes. Choices:
|
|
The state of the resource being configured by the module on the NetScaler ADC node. When When Choices:
|
|
Name of the Load Balancing virtual server to which the content is switched, if policy rule is evaluated to be TRUE. Example: bind cs vs cs1 -policyname pol1 -priority 101 -targetLBVserver lb1 Note: Use this parameter only in case of Content Switching policy bind operations to a CS vserver |
|
If Choices:
|
Notes
Note
For more information on using Ansible to manage NetScaler ADC Network devices see https://www.ansible.com/integrations/networks/citrixadc.
Examples
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Indicates if any change is made by the module Returned: always Sample: |
|
Dictionary of before and after changes Returned: always Sample: |
|
List of differences between the actual configured object and the configuration specified in the module Returned: when changed Sample: |
|
Indicates if the module failed or not Returned: always Sample: |
|
list of logged messages by the module Returned: always Sample: |