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

Note

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

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

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.

Examples

- name: Gather Information Details of all ZIA Forwarding Control Rule
  zscaler.ziacloud.zia_forwarding_control_rules_facts:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA Forwarding Control Rule by Name
  zscaler.ziacloud.zia_forwarding_control_rules_facts:
    provider: '{{ provider }}'
    name: "Example"

Authors

  • William Guilherme (@willguibr)