Try SpotterConfiguration for Web authentication action resource.
| "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.1Configuration for Web authentication action resource.
name:
description:
- Name for the Web Authentication action.
- Must begin with a letter, number, or the underscore character (_), and must contain
only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@),
equals (=), colon (:), and underscore characters. Cannot be changed after the profile
is created.
- ''
- 'The following requirement applies only to the Citrix ADC CLI:'
- If the name includes one or more spaces, enclose the name in double or single quotation
marks (for example, "my authentication action" or 'my authentication action').
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
- unset
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.
- When C(unset), the resource will be unset on the NetScaler ADC node.
type: str
scheme:
choices:
- http
- https
description:
- Type of scheme for the web 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
serverip:
description:
- IP address of the web server to be used for authentication.
type: str
attribute1:
description:
- Expression that would be evaluated to extract attribute1 from the webauth response
type: str
attribute2:
description:
- Expression that would be evaluated to extract attribute2 from the webauth response
type: str
attribute3:
description:
- Expression that would be evaluated to extract attribute3 from the webauth response
type: str
attribute4:
description:
- Expression that would be evaluated to extract attribute4 from the webauth response
type: str
attribute5:
description:
- Expression that would be evaluated to extract attribute5 from the webauth response
type: str
attribute6:
description:
- Expression that would be evaluated to extract attribute6 from the webauth response
type: str
attribute7:
description:
- Expression that would be evaluated to extract attribute7 from the webauth response
type: str
attribute8:
description:
- Expression that would be evaluated to extract attribute8 from the webauth response
type: str
attribute9:
description:
- Expression that would be evaluated to extract attribute9 from the webauth response
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
serverport:
description:
- Port on which the web server accepts connections.
type: int
attribute10:
description:
- Expression that would be evaluated to extract attribute10 from the webauth response
type: str
attribute11:
description:
- Expression that would be evaluated to extract attribute11 from the webauth response
type: str
attribute12:
description:
- Expression that would be evaluated to extract attribute12 from the webauth response
type: str
attribute13:
description:
- Expression that would be evaluated to extract attribute13 from the webauth response
type: str
attribute14:
description:
- Expression that would be evaluated to extract attribute14 from the webauth response
type: str
attribute15:
description:
- Expression that would be evaluated to extract attribute15 from the webauth response
type: str
attribute16:
description:
- Expression that would be evaluated to extract attribute16 from the webauth response
type: str
fullreqexpr:
description:
- Exact HTTP request, in the form of an expression, which the Citrix ADC sends to
the authentication server.
- The Citrix ADC does not check the validity of this request. One must manually validate
the request.
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
successrule:
description:
- Expression, that checks to see if authentication is successful.
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
defaultauthenticationgroup:
description:
- This is the default group that is chosen when the authentication succeeds in addition
to extracted groups.
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