zscaler.ziacloud.zia_bandwidth_control_rules_info module – Retrieves all the rules in the Bandwidth Control policy.

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves all the rules in the Bandwidth Control 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.

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"

id

integer

Unique identifier for the Bandwidth Control Rule

name

string

Name of the Bandwidth Control Rule

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 ZIA Bandwidth Control Rule
  zscaler.ziacloud.zia_bandwidth_control_rules_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA Bandwidth Control Rule by Name
  zscaler.ziacloud.zia_bandwidth_control_rules_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 Bandwidth Control Rules.

Returned: always

access_control

string

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

Returned: always

Sample: "READ_WRITE"

bandwidth_classes

list / elements=integer

The bandwidth classes to which you want to apply this rule

Returned: always

Sample: [4, 8]

id

integer

The unique identifier of the Bandwidth Control 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 Bandwidth Control Rule.

Returned: always

Sample: "DNAT_1"

order

integer

The order of the rule in the list of Bandwidth Control Rule.

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 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"

Authors

  • William Guilherme (@willguibr)