zscaler.ziacloud.zia_cloud_firewall_time_windows_info module – List of time intervals

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

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 Time Interval

name

string

Name of the Time Interval

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: 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)