zscaler.ziacloud.zia_url_filtering_rule_info module – Gets all url filtering rules.

Note

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

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_filtering_rule_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets all rules in the URL filtering policy.

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"

id

integer

URL Filtering Rule ID

name

string

Name of the URL filtering rule

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 filtering rules
  zscaler.ziacloud.zia_url_filtering_rule_info:
    provider: '{{ provider }}'

- name: Gather Information Details of of a URL filtering rules
  zscaler.ziacloud.zia_url_filtering_rule_info:
    provider: '{{ provider }}'
    name: "Example"

Return Values

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

Key

Description

rules

list / elements=dictionary

A list of URL filtering rules fetched based on the given criteria.

Returned: always

access_control

string

Access control setting for the rule.

Returned: always

Sample: "READ_WRITE"

action

string

Action taken when the rule is matched.

Returned: always

Sample: "ALLOW"

block_override

boolean

Indicates if the block action can be overridden.

Returned: always

Sample: false

departments

list / elements=dictionary

List of departments to which the rule applies.

Returned: always

id

integer

The unique identifier for the department.

Returned: always

Sample: 99364434

name

string

The name of the department.

Returned: always

Sample: "A000"

device_trust_levels

list / elements=string

Device trust levels applicable to the rule.

Returned: always

Sample: ["UNKNOWN_DEVICETRUSTLEVEL", "LOW_TRUST", "MEDIUM_TRUST", "HIGH_TRUST"]

groups

list / elements=dictionary

List of groups to which the rule applies.

Returned: always

id

integer

The unique identifier for the group.

Returned: always

Sample: 76662385

name

string

The name of the group.

Returned: always

Sample: "A000"

id

integer

The unique identifier for the URL filtering rule.

Returned: always

Sample: 1203256

name

string

The name of the URL filtering rule.

Returned: always

Sample: "URL_Filtering_1"

order

integer

The order of the rule within the ruleset.

Returned: always

Sample: 1

protocols

list / elements=string

List of protocols to which the rule applies.

Returned: always

Sample: ["HTTPS_RULE", "HTTP_RULE"]

rank

integer

The rank of the rule for execution priority.

Returned: always

Sample: 7

request_methods

list / elements=string

HTTP request methods to which the rule applies.

Returned: always

Sample: ["GET", "POST", "HEAD"]

state

string

The current state of the URL filtering rule.

Returned: always

Sample: "ENABLED"

user_agent_types

list / elements=string

User agent types affected by the rule.

Returned: always

Sample: ["OPERA", "MSIE", "MSEDGE", "CHROME"]

user_risk_score_levels

list / elements=string

User risk score levels applicable to the rule.

Returned: always

Sample: ["LOW", "MEDIUM", "HIGH", "CRITICAL"]

Authors

  • William Guilherme (@willguibr)