netscaler.adc.policyurlset (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 URL set resource.

Inputs

    
url:
    description:
    - 'URL (protocol, host, path and file name) from where the CSV (comma separated file)
      file will be imported or exported. Each record/line will one entry within the urlset.
      The first field contains the URL pattern, subsequent fields contains the metadata,
      if available. HTTP, HTTPS and FTP protocols are supported. NOTE: The operation fails
      if the destination HTTPS server requires client certificate authentication for access.'
    type: str

name:
    description:
    - Unique name of the url set. Not case sensitive. Must begin with an ASCII letter
      or underscore (_) character and must contain only alphanumeric and underscore characters.
      Must not be the name of an existing named expression, pattern set, dataset, string
      map, or HTTP callout.
    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
    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.
    type: str

comment:
    description:
    - Any comments to preserve information about this url set.
    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

imported:
    description:
    - when set, display shows all imported urlsets.
    type: bool

interval:
    description:
    - The interval, in seconds, rounded down to the nearest 15 minutes, at which the update
      of urlset occurs.
    type: float

canaryurl:
    description:
    - Add this URL to this urlset. Used for testing when contents of urlset is kept confidential.
    type: str

delimiter:
    description:
    - CSV file record delimiter.
    type: str

matchedid:
    description:
    - An ID that would be sent to AppFlow to indicate which URLSet was the last one that
      matched the requested URL.
    type: float

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

privateset:
    description:
    - Prevent this urlset from being exported.
    type: bool

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

rowseparator:
    description:
    - CSV file row separator.
    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

subdomainexactmatch:
    description:
    - Force exact subdomain matching, ex. given an entry 'google.com' in the urlset, a
      request to 'news.google.com' won't match, if subdomainExactMatch is set.
    type: bool

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