zscaler.ziacloud.zia_forwarding_control_rule_info module – Gets all rules in the Forwarding Control policy.

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets the list of forwarding rules configured in the ZIA Admin Portal.

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

Unique identifier for the Forwarding Filtering policy rule

name

string

Name of the Forwarding Filtering policy 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 ZIA Forwarding Control Rule
  zscaler.ziacloud.zia_forwarding_control_rule_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA Forwarding Control Rule by Name
  zscaler.ziacloud.zia_forwarding_control_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 ZIA forwarding control rules.

Returned: always

access_control

string

Access control setting for the rule, describing the access permission.

Returned: always

Sample: "READ_WRITE"

dest_addresses

list / elements=string

List of destination IP addresses for the rule.

Returned: always

Sample: ["192.168.100.1", "192.168.100.2", "192.168.100.3"]

dest_countries

list / elements=string

List of destination country codes affected by the rule.

Returned: always

Sample: ["COUNTRY_CA", "COUNTRY_GB"]

dest_ip_categories

list / elements=string

List of destination IP categories specified in the rule.

Returned: always

dest_ip_groups

list / elements=dictionary

List of destination IP groups affected by the rule.

Returned: always

id

integer

The unique identifier of the IP group.

Returned: always

Sample: 3254355

name

string

The name of the IP group.

Returned: always

Sample: "Example1000"

forward_method

string

The forwarding method specified in the rule (e.g., DIRECT, VPN).

Returned: always

Sample: "DIRECT"

id

integer

The unique identifier of the forwarding rule.

Returned: always

Sample: 1197791

location_groups

list / elements=dictionary

List of location groups associated with the rule.

Returned: always

id

integer

The unique identifier of the location group.

Returned: always

Sample: 44772849

name

string

The name of the location group.

Returned: always

Sample: "Server Traffic Group"

name

string

The name of the forwarding control rule.

Returned: always

Sample: "FWD_1"

order

integer

The order of the rule in the list of forwarding rules.

Returned: always

Sample: 1

rank

integer

The rank assigned to the rule for priority.

Returned: always

Sample: 7

state

string

The state of the rule (e.g., ENABLED, DISABLED).

Returned: always

Sample: "ENABLED"

type

string

The type of forwarding rule.

Returned: always

Sample: "FORWARDING"

Authors

  • William Guilherme (@willguibr)