netscaler.adc.authenticationloginschema (2.5.1) — module

Install collection

Install with ansible-galaxy collection install netscaler.adc:==2.5.1

Add to requirements.yml

  collections:
    - name: netscaler.adc
      version: 2.5.1

Description

Configuration for 0 resource.

Inputs

    
name:
    description:
    - Name for the new login schema. Login schema defines the way login form is rendered.
      It provides a way to customize the fields that are shown to the user. Must begin
      with an ASCII alphanumeric or underscore (_) character, and must contain only ASCII
      alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals
      (=), and hyphen (-) characters. Cannot be changed after an action 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 action" or 'my 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

api_path:
    default: nitro/v1/config
    description:
    - Base NITRO API path.
    - Define only in case of an ADM service proxy call
    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

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

ssocredentials:
    choices:
    - 'YES'
    - 'NO'
    description:
    - This option indicates whether current factor credentials are the default SSO (SingleSignOn)
      credentials.
    type: str

userexpression:
    description:
    - Expression for username extraction during login. This can be any relevant advanced
      policy expression.
    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

passwdexpression:
    description:
    - Expression for password extraction during login. This can be any relevant advanced
      policy expression.
    type: str

usercredentialindex:
    description:
    - The index at which user entered username should be stored in session.
    type: float

authenticationschema:
    description:
    - Name of the file for reading authentication schema to be sent for Login Page UI.
      This file should contain xml definition of elements as per Citrix Forms Authentication
      Protocol to be able to render login form. If administrator does not want to prompt
      users for additional credentials but continue with previously obtained credentials,
      then "noschema" can be given as argument. Please note that this applies only to
      loginSchemas that are used with user-defined factors, and not the vserver factor.
    type: str

authenticationstrength:
    description:
    - Weight of the current authentication
    type: float

passwordcredentialindex:
    description:
    - The index at which user entered password should be stored in session.
    type: float

Outputs

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