zscaler.ziacloud.zia_cloud_firewall_time_windows_info module – List of time intervals

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of time intervals used for by the Firewall policy or the URL Filtering 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 Time Interval

name

string

Name of the Time Interval

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 Time Intervals
  zscaler.ziacloud.zia_cloud_firewall_time_windows_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a ZIA Time Interval by Name
  zscaler.ziacloud.zia_cloud_firewall_time_windows_info:
    provider: '{{ provider }}'
    name: "Off hours"

Return Values

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

Key

Description

time_windows

list / elements=dictionary

Details of the ZIA time interval or a list of time intervals retrieved.

Returned: always

day_of_week

list / elements=string

List of days of the week the time window is active.

Returned: always

Sample: ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"]

end_time

integer

End time of the time interval, measured in minutes from midnight (0-1440).

Returned: always

Sample: 420

id

integer

Unique identifier for the time interval.

Returned: always

Sample: 1833

name

string

Name of the time interval.

Returned: always

Sample: "Off hours"

start_time

integer

Start time of the time interval, measured in minutes from midnight (0-1440).

Returned: always

Sample: 0

Authors

  • William Guilherme (@willguibr)