Try SpotterBinding Resource definition for describing association between vpnvserver and authenticationdfapolicy 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 vpnvserver and authenticationdfapolicy resources
name:
description:
- Name of the virtual server.
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
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
policy:
description:
- The name of the policy, if any, bound to the VPN virtual server.
type: str
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:
- Integer specifying the policy's priority. The lower the number, the higher the priority.
Policies are evaluated in the order of their priority numbers. Maximum value for
default syntax policies is 2147483647 and for classic policies is 64000.
type: float
bindpoint:
choices:
- REQUEST
- RESPONSE
- ICA_REQUEST
- OTHERTCP_REQUEST
- AAA_REQUEST
- AAA_RESPONSE
description:
- Bind point to which to bind the policy. Applies only to rewrite and cache policies.
If you do not set this parameter, the policy is bound to REQ_DEFAULT or RES_DEFAULT,
depending on whether the policy rule is a response-time or a request-time expression.
type: str
secondary:
description:
- Binds the authentication policy as the secondary policy to use in a two-factor configuration.
A user must then authenticate not only via a primary authentication method but also
via a secondary authentication method. User groups are aggregated across both. The
user name must be exactly the same for both authentication methods, but they can
require different passwords.
type: bool
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
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
groupextraction:
description:
- Binds the authentication policy to a tertiary chain which will be used only for
group extraction. The user will not authenticate against this server, and this
will only be called if primary and/or secondary authentication has succeeded.
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:
- 'Applicable only to advance vpn session policy. Expression or other value specifying
the next policy to evaluate if the current policy evaluates to TRUE. Specify one
of the following values:'
- '* NEXT - Evaluate the policy with the next higher priority number.'
- '* END - End policy evaluation.'
- '* An expression that evaluates to a number.'
- 'If you specify an expression, the number to which it evaluates determines the next
policy to evaluate, as follows:'
- '* If the expression evaluates to a higher numbered priority, the policy with that
priority is evaluated next.'
- '* If the expression evaluates to the priority of the current policy, the policy
with the next higher numbered priority is evaluated next.'
- '* If the expression evaluates to a number that is larger than the largest numbered
priority, 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