zscaler.ziacloud.zia_url_categories_info module – Gets information about all or custom URL categories.

Note

This module is part of the zscaler.ziacloud collection (version 1.3.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install zscaler.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_url_categories_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets information about all or custom URL categories.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

configured_name

string

Name of the URL category. This is only required for custom URL categories.

id

string

URL category ID. See https://help.zscaler.com/zia/url-categories#/urlCategories-get

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

A string that contains the email ID of the API admin.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Information Details of all URL Categories
  zscaler.ziacloud.zia_url_categories_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a specific URL Category by ID
  zscaler.ziacloud.zia_url_categories_info:
    provider: '{{ provider }}'
    id: "OTHER_ADULT_MATERIAL"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

categories

list / elements=dictionary

A list of URL categories fetched based on the given criteria.

Returned: always

configured_name

string

The name configured for the URL category.

Returned: when custom categories are queried

Sample: "Example100"

custom_category

boolean

Indicates if the category is a custom category.

Returned: always

Sample: true

custom_ip_ranges_count

integer

The count of custom IP ranges in the category.

Returned: when custom categories are queried

Sample: 2

custom_urls_count

integer

The count of custom URLs in the category.

Returned: when custom categories are queried

Sample: 11

db_categorized_urls

list / elements=string

A list of URLs categorized under this category by the database.

Returned: when custom categories are queried

Sample: [".creditkarma.com", ".youku.com"]

description

string

The description of the URL category.

Returned: always

Sample: "Example100"

editable

boolean

Indicates if the category is editable.

Returned: always

Sample: true

id

string

The unique identifier for the URL category.

Returned: always

Sample: "CUSTOM_02"

ip_ranges

list / elements=string

A list of IP ranges categorized under this category.

Returned: when custom categories are queried

Sample: ["3.235.112.0/24", "3.217.228.0/25"]

ip_ranges_retaining_parent_category

list / elements=string

List of IP ranges retaining their parent category’s classification.

Returned: when custom categories are queried

Sample: ["13.107.6.152/31"]

ip_ranges_retaining_parent_category_count

integer

The count of IP ranges retaining their parent category’s classification.

Returned: when custom categories are queried

Sample: 1

keywords

list / elements=string

Keywords associated with the category.

Returned: when custom categories are queried

Sample: ["microsoft"]

keywords_retaining_parent_category

list / elements=string

Keywords retaining their parent category’s classification.

Returned: when custom categories are queried

Sample: []

type

string

The type of the URL category.

Returned: always

Sample: "URL_CATEGORY"

urls

list / elements=string

A list of URLs categorized under this category.

Returned: when custom categories are queried

Sample: [".coupons.com", ".resource.alaskaair.net"]

urls_retaining_parent_category_count

integer

The count of URLs retaining their parent category’s classification.

Returned: when custom categories are queried

Sample: 2

val

integer

A custom value associated with the category.

Returned: when custom categories are queried

Sample: 129

Authors

  • William Guilherme (@willguibr)