netscaler.adc.nsextension (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 Extension resource.

Inputs

    
src:
    description:
    - Local path to and name of, or URL (protocol, host, path, and file name) for, the
      file in which to store the imported extension.
    - 'NOTE: The import fails if the object to be imported is on an HTTPS server that
      requires client certificate authentication for access.'
    type: str

name:
    description:
    - Name to assign to the extension object on the Citrix ADC.
    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
    - imported
    - 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(imported), the resource will be imported on the NetScaler ADC node.
    - When C(unset), the resource will be unset on the NetScaler ADC node.
    type: str

trace:
    choices:
    - 'off'
    - calls
    - lines
    - all
    description:
    - 'Enables tracing to the NS log file of extension execution:'
    - '   C(off)   - turns C(off) tracing (equivalent to unset ns extension <extension-name>
      -trace)'
    - '   C(calls) - traces extension function C(calls) with arguments and function returns
      with the first return value'
    - '   C(lines) - traces the above plus line numbers for executed extension C(lines)'
    - '   C(all)   - traces the above plus local variables changed by executed extension
      C(lines)'
    - Note that the DEBUG log level must be enabled to see extension tracing.
    - This can be done by set audit syslogParams -loglevel ALL or -loglevel DEBUG.
    type: str

detail:
    choices:
    - brief
    - all
    description:
    - Show detail for extension function.
    type: str

comment:
    description:
    - Any comments to preserve information about the extension object.
    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

overwrite:
    description:
    - Overwrites the existing file
    type: bool

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

tracefunctions:
    description:
    - Comma-separated list of extension functions to trace. By default, all extension
      functions are traced.
    type: str

tracevariables:
    description:
    - Comma-separated list of variables (in traced extension functions) to trace. By default,
      all variables are traced.
    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