Try SpotterBinding Resource definition for describing association between cmpglobal and cmppolicy 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 cmpglobal and cmppolicy 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
- RES_OVERRIDE
- RES_DEFAULT
- HTTPQUIC_REQ_OVERRIDE
- HTTPQUIC_REQ_DEFAULT
- HTTPQUIC_RES_OVERRIDE
- HTTPQUIC_RES_DEFAULT
- NONE
description:
- Bind point to which the policy is bound.
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:
- Invoke policies bound to a virtual server or a policy label. After the invoked policies
are evaluated, the flow returns to the policy with the next priority.
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:
- Positive integer specifying the priority of the policy. The lower the number, the
higher the priority. By default, polices within a label are evaluated in the order
of their priority numbers.
- In the configuration utility, you can click the Priority field and edit the priority
level or drag the entry to a new position in the list. If you drag the entry to
a new position, the priority level is updated automatically.
type: float
labelname:
description:
- Name of the label to invoke if the current policy rule evaluates to TRUE.
type: str
labeltype:
choices:
- reqvserver
- resvserver
- policylabel
description:
- Type of policy label invocation.
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:
- The name of the globally bound HTTP compression 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 or other value specifying the priority of the next policy, within the
policy label, to evaluate if the current policy evaluates to TRUE. Specify one
of the following values:'
- '* NEXT - Evaluate the policy with the next higher numbered priority.'
- '* END - Stop evaluation.'
- '* USE_INVOCATION_RESULT - Applicable if this policy invokes another policy label.
If the final goto in the invoked policy label has a value of END, the evaluation
stops. If the final goto is anything other than END, the current policy label performs
a NEXT.'
- '* An expression that evaluates to a number.'
- 'If you specify an expression, it''s evaluation result determines the next policy
to evaluate, as follows:'
- '* If the expression evaluates to a higher numbered priority, that policy is evaluated
next.'
- '* If the expression evaluates to the priority of the current policy, the policy
with the next higher priority number is evaluated next.'
- '* If the expression evaluates to a priority number that is numerically higher than
the highest priority number, policy evaluation ends.'
- 'An UNDEF event is triggered if:'
- '* The expression is invalid.'
- '* The expression evaluates to a priority number that is numerically lower than
the current policy''s priority.'
- '* The expression evaluates to a priority number that is between the current policy''s
priority number (say, 30) and the highest priority number (say, 100), but does not
match any configured priority number (for example, the expression evaluates to the
number 85). This example assumes that the priority number increments by 10 for every
successive policy, and therefore a priority number of 85 does not exist in the policy
label.'
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