netscaler.adc.tmformssoaction (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 Form sso action resource.

Inputs

    
name:
    description:
    - Name for the new form-based single sign-on profile. 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 SSO 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

nvtype:
    choices:
    - STATIC
    - DYNAMIC
    description:
    - Type of processing of the name-value pair. If you specify C(STATIC), the values
      configured by the administrator are used. For C(DYNAMIC), the response is parsed,
      and the form is extracted and then submitted.
    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

actionurl:
    description:
    - URL to which the completed form is submitted.
    type: str

userfield:
    description:
    - Name of the form field in which the user types in the user ID.
    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

passwdfield:
    description:
    - Name of the form field in which the user types in the password.
    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

responsesize:
    description:
    - Number of bytes, in the response, to parse for extracting the forms.
    type: float

submitmethod:
    choices:
    - GET
    - POST
    description:
    - HTTP method used by the single sign-on form to send the logon credentials to the
      logon server. Applies only to STATIC name-value type.
    type: str

namevaluepair:
    description:
    - Name-value pair attributes to send to the server in addition to sending the username
      and password. Value names are separated by an ampersand (&) (for example, name1=value1&name2=value2).
    type: str

nitro_protocol:
    choices:
    - http
    - https
    default: https
    description:
    - Which protocol to use when accessing the nitro API objects.
    type: str

ssosuccessrule:
    description:
    - Expression, that checks to see if single sign-on is successful.
    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

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