netscaler.adc.authenticationepaaction (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 epa action resource.

Inputs

    
name:
    description:
    - Name for the epa action. Must begin with a
    - "\t    letter, number, or the underscore character (_), and must consist"
    - "\t    only of letters, numbers, and the hyphen (-), period (.) pound"
    - "\t    (#), space ( ), at (@), equals (=), colon (:), and underscore"
    - "\t\t    characters. Cannot be changed after epa 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 aaa action\" or 'my aaa 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

csecexpr:
    description:
    - it holds the ClientSecurityExpression to be sent to the client
    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

deletefiles:
    description:
    - String specifying the path(s) and name(s) of the files to be deleted by the endpoint
      analysis (EPA) tool. Multiple files to be delimited by comma
    type: str

killprocess:
    description:
    - String specifying the name of a process to be terminated by the endpoint analysis
      (EPA) tool. Multiple processes to be delimited by comma
    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

defaultepagroup:
    description:
    - This is the default group that is chosen when the EPA check succeeds.
    type: str

quarantinegroup:
    description:
    - This is the quarantine group that is chosen when the EPA check fails
    - if configured.
    type: str

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