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 2.0.3).

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.

• Zscaler SDK Python can be obtained from PyPI https://pypi.org/project/zscaler-sdk-python/

Parameters

Parameter	Comments
api_key string	A string that contains the obfuscated API key.
client_id string	The client ID for OAuth2 authentication.
client_secret string	The client secret for OAuth2 authentication.
cloud string	The Zscaler cloud name provisioned for your organization. Choices: "zscloud" "zscaler" "zscalerone" "zscalertwo" "zscalerthree" "zscalerbeta" "zscalergov" "zscalerten" "beta" "production"
custom_only boolean	If set to true, gets information on custom URL categories only. Choices: false true
id string	URL category ID. See https://help.zscaler.com/zia/url-categories#/urlCategories-get
include_only_url_keyword_counts boolean	By default this parameter is set to false, so the response includes URLs and keywords for custom URL categories only If set to true, the response only includes URL and keyword counts. Choices: false true
name string	Name of the URL category. This is only required for custom URL categories.
password string	A string that contains the password for the API admin.
private_key string	The private key for JWT-based OAuth2 authentication.
provider dictionary	A dict containing authentication credentials.
api_key string	Obfuscated API key.
client_id string	OAuth2 client ID.
client_secret string	OAuth2 client secret.
cloud string	Zscaler cloud name. Choices: "zscloud" "zscaler" "zscalerone" "zscalertwo" "zscalerthree" "zscalerbeta" "zscalergov" "zscalerten" "beta" "production"
password string	Password for the API admin.
private_key string	Private key for OAuth2 JWT.
sandbox_cloud string	Sandbox Cloud environment.
sandbox_token string	Sandbox API Key.
use_legacy_client boolean	Whether to use the legacy Zscaler API client. Choices: false ← (default) true
username string	Email ID of the API admin.
vanity_domain string	Vanity domain for OAuth2.
sandbox_cloud string	The Sandbox cloud environment for API access.
sandbox_token string	A string that contains the Sandbox API Key.
use_legacy_client boolean	Whether to use the legacy Zscaler API client. Choices: false ← (default) true
username string	A string that contains the email ID of the API admin.
vanity_domain string	The vanity domain provisioned by Zscaler for OAuth2 flows.

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
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: []
name string	The name configured for the URL category. Returned: when custom categories are queried Sample: "Example100"
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)

Collection links

• Issue Tracker
• Repository (Sources)