zscaler.ziacloud.zia_rule_labels_info module – Gets a list of rule labels

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of rule labels

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

The unique identifier for the rule label.

name

string

The rule label name.

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: Gets all list of rule label
  zscaler.ziacloud.zia_rule_labels_info:
    provider: '{{ provider }}'

- name: Gets a list of rule label by name
  zscaler.ziacloud.zia_rule_labels_info:
    provider: '{{ provider }}'
    name: "example"

Return Values

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

Key

Description

labels

list / elements=dictionary

A list of rule labels fetched based on the given criteria.

Returned: always

created_by

complex

Information about the user who created the rule label.

Returned: always

id

integer

The identifier of the user who created the rule label.

Returned: always

Sample: 44772836

name

string

The name of the user who created the rule label.

Returned: always

Sample: "admin@44772833.zscalertwo.net"

description

string

A description of the rule label.

Returned: always

Sample: "Example description"

id

integer

The unique identifier for the rule label.

Returned: always

Sample: 3687131

last_modified_by

complex

Information about the user who last modified the rule label.

Returned: always

id

integer

The identifier of the user who last modified the rule label.

Returned: always

Sample: 44772836

name

string

The name of the user who last modified the rule label.

Returned: always

Sample: "admin@44772833.zscalertwo.net"

last_modified_time

integer

The Unix timestamp when the rule label was last modified.

Returned: always

Sample: 1721347034

name

string

The name of the rule label.

Returned: always

Sample: "Example"

referenced_rule_count

integer

The number of rules that reference this label.

Returned: always

Sample: 0

Authors

  • William Guilherme (@willguibr)