netscaler.adc.transformaction (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 transform action resource.

Inputs

    
name:
    description:
    - Name for the URL transformation action.
    - Must begin with a letter, number, or the underscore character (_), and must contain
      only letters, numbers, and the hyphen (-), period (.) pound (#), space ( ), at (@),
      equals (=), colon (:), and underscore characters. Cannot be changed after the URL
      Transformation action is added.
    - ''
    - '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 transform action or my transform 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

comment:
    description:
    - Any comments to preserve information about this URL Transformation action.
    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

priority:
    description:
    - Positive integer specifying the priority of the action within the profile. A lower
      number specifies a higher priority. Must be unique within the list of actions bound
      to the profile. Policies are evaluated in the order of their priority numbers, and
      the first policy that matches is applied.
    type: float

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

requrlfrom:
    description:
    - PCRE-format regular expression that describes the request URL pattern to be transformed.
    type: str

requrlinto:
    description:
    - PCRE-format regular expression that describes the transformation to be performed
      on URLs that match the reqUrlFrom pattern.
    type: str

resurlfrom:
    description:
    - PCRE-format regular expression that describes the response URL pattern to be transformed.
    type: str

resurlinto:
    description:
    - PCRE-format regular expression that describes the transformation to be performed
      on URLs that match the resUrlFrom pattern.
    type: str

profilename:
    description:
    - Name of the URL Transformation profile with which to associate this action.
    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

cookiedomainfrom:
    description:
    - Pattern that matches the domain to be transformed in Set-Cookie headers.
    type: str

cookiedomaininto:
    description:
    - 'PCRE-format regular expression that describes the transformation to be performed
      on cookie domains that match the cookieDomainFrom pattern. '
    - 'NOTE: The cookie domain to be transformed is extracted from the request.'
    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