zscaler.ziacloud.zia_alerts_info module – Gets information about ZIA alert subscriptions

Note

This module is part of the zscaler.ziacloud collection (version 2.2.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_alerts_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of alert subscriptions or retrieves a specific subscription by ID or email.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

email

string

The email address of the alert recipient.

Used to look up a subscription by recipient email.

id

integer

The unique identifier for the alert subscription.

System-generated identifier for the alert subscription.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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: Get all alert subscriptions
  zscaler.ziacloud.zia_alerts_info:
    provider: '{{ provider }}'

- name: Get an alert subscription by ID
  zscaler.ziacloud.zia_alerts_info:
    provider: '{{ provider }}'
    id: 123456

- name: Get an alert subscription by email
  zscaler.ziacloud.zia_alerts_info:
    provider: '{{ provider }}'
    email: "alerts@example.com"

Return Values

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

Key

Description

subscriptions

list / elements=dictionary

A list of alert subscriptions fetched based on the given criteria.

Returned: always

comply_severities

list / elements=string

Severity levels for Comply Alert class.

Returned: always

deleted

boolean

Indicates whether the alert subscription is marked as deleted.

Returned: when available

description

string

Additional comments or information about the alert subscription.

Returned: always

email

string

The email address of the alert recipient.

Returned: always

Sample: "alerts@example.com"

id

integer

The unique identifier for the alert subscription (system-generated).

Returned: always

Sample: 123456

manage_severities

list / elements=string

Severity levels for Manage Alert class.

Returned: always

pt0_severities

list / elements=string

Severity levels for Patient 0 Alert class (CRITICAL, MAJOR, MINOR, INFO, DEBUG).

Returned: always

secure_severities

list / elements=string

Severity levels for Secure Alert class.

Returned: always

system_severities

list / elements=string

Severity levels for System Alerts class.

Returned: always

Authors

  • William Guilherme (@willguibr)