netscaler.adc.tmsessionaction (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 TM session action resource.

Inputs

    
sso:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Use single sign-on (SSO) to log users on to all web applications automatically after
      they authenticate, or pass users to the web application logon page to authenticate
      to each application individually. Note that this configuration does not honor the
      following authentication types for security reason. BASIC, DIGEST, and NTLM (without
      Negotiate NTLM2 Key or Negotiate Sign Flag). Use TM TrafficAction to configure SSO
      for these authentication types.
    type: str

name:
    description:
    - Name for the session action. 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 a session 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

homepage:
    description:
    - Web address of the home page that a user is displayed when authentication vserver
      is bookmarked and used to login.
    type: str

ssodomain:
    description:
    - Domain to use for single sign-on (SSO).
    type: str

kcdaccount:
    description:
    - Kerberos constrained delegation account name
    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

sesstimeout:
    description:
    - Session timeout, in minutes. If there is no traffic during the timeout period, the
      user is disconnected and must reauthenticate to access intranet resources.
    type: float

ssocredential:
    choices:
    - PRIMARY
    - SECONDARY
    description:
    - Use the primary or secondary authentication credentials for single sign-on (SSO).
    type: str

httponlycookie:
    choices:
    - 'YES'
    - 'NO'
    description:
    - Allow only an HTTP session cookie, in which case the cookie cannot be accessed by
      scripts.
    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

persistentcookie:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Enable or disable persistent SSO cookies for the traffic management (TM) session.
      A persistent cookie remains on the user device and is sent with each HTTP request.
      The cookie becomes stale if the session ends. This setting is overwritten if a traffic
      action sets persistent cookie to C(OFF).
    - 'Note: If persistent cookie is enabled, make sure you set the persistent cookie
      validity.'
    type: str

persistentcookievalidity:
    description:
    - Integer specifying the number of minutes for which the persistent cookie remains
      valid. Can be set only if the persistent cookie setting is enabled.
    type: float

defaultauthorizationaction:
    choices:
    - ALLOW
    - DENY
    description:
    - Allow or deny access to content for which there is no specific authorization policy.
    type: str

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