netscaler.adc.vpnclientlessaccessprofile (2.5.1) — module

Configuration for Clientless VPN rewrite profile resource.

| "added in version" 2.0.0 of netscaler.adc"

Authors: Sumanth Lingappa (@sumanth-lingappa)

preview | supported by community

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 Clientless VPN rewrite profile resource.

Inputs

    
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

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

profilename:
    description:
    - Name for the Citrix Gateway clientless access profile. Must begin with an ASCII
      alphabetic or underscore (_) character, and must consist only of ASCII alphanumeric,
      underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen
      (-) characters. Cannot be changed after the profile 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 profile" or 'my profile').
    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

nitro_auth_token:
    description:
    - The authentication token provided by a login operation.
    type: str
    version_added: 2.6.0
    version_added_collection: netscaler.adc

clientconsumedcookies:
    description:
    - Specify the name of the pattern set containing the names of the cookies, which are
      allowed between the client and the server. If a pattern set is not specified, Citrix
      Gateway does not allow any cookies between the client and the server. A cookie that
      is not specified in the pattern set is handled by Citrix Gateway on behalf of the
      client.
    type: str

urlrewritepolicylabel:
    description:
    - Name of the configured URL rewrite policy label. If you do not specify a policy
      label name, then URLs are not rewritten.
    type: str

regexforfindingurlincss:
    description:
    - Name of the pattern set that contains the regular expressions, which match the URL
      in the CSS.
    type: str

regexforfindingurlinxml:
    description:
    - Name of the pattern set that contains the regular expressions, which match the URL
      in XML.
    type: str

requirepersistentcookie:
    choices:
    - 'ON'
    - 'OFF'
    description:
    - Specify whether a persistent session cookie is set and accepted for clientless access.
      If this parameter is set to C(ON), COM objects, such as MSOffice, which are invoked
      by the browser can access the files using clientless access. Use caution because
      the persistent cookie is stored on the disk.
    type: str

reqhdrrewritepolicylabel:
    description:
    - Name of the configured Request rewrite policy label.  If you do not specify a policy
      label name, then requests are not rewritten.
    type: str

reshdrrewritepolicylabel:
    description:
    - Name of the configured Response rewrite policy label.
    type: str

regexforfindingcustomurls:
    description:
    - Name of the pattern set that contains the regular expressions, which match the URLs
      in the custom content type other than HTML, CSS, XML, XCOMP, and JavaScript. The
      custom content type should be included in the patset ns_cvpn_custom_content_types.
    type: str

javascriptrewritepolicylabel:
    description:
    - Name of the configured JavaScript rewrite policy label.  If you do not specify a
      policy label name, then JAVA scripts are not rewritten.
    type: str

regexforfindingurlinjavascript:
    description:
    - Name of the pattern set that contains the regular expressions, which match the URL
      in Java script.
    type: str

regexforfindingurlinxcomponent:
    description:
    - Name of the pattern set that contains the regular expressions, which match the URL
      in X Component.
    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