zscaler.zpacloud.zpa_connector_assistant_schedule_info module – Gets the Auto Delete frequency of the App Connector.

Note

This module is part of the zscaler.zpacloud 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.zpacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.zpacloud.zpa_connector_assistant_schedule_info.

New in zscaler.zpacloud 1.0.0

Synopsis

  • Gets the Auto Delete frequency configuration of the App Connector.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The unique identifier of the ZPA tenant

id

string

The unique identifier for the App Connector auto deletion configuration for a customer.

This field is only required for the PUT request to update the frequency of the App Connector Settings.

provider

dictionary

A dict object containing authentication details.

client_id

string

The ZPA API client ID generated from the ZPA console.

client_secret

string

The ZPA API client secret generated from the ZPA console.

cloud

string

The ZPA cloud provisioned for your organization.

Choices:

  • "PRODUCTION"

  • "BETA"

  • "QA"

  • "QA2"

  • "GOV"

  • "GOVUS"

  • "PREVIEW"

  • "ZPATWO"

customer_id

string

The ZPA tenant ID found in the Administration Company menu in the ZPA console.

Notes

Note

  • Check mode is not supported.

Examples

- name: Gather Details of All Assistant Schedules
  zscaler.zpacloud.zpa_connector_assistant_schedule_info:
    provider: "{{ zpa_cloud }}"

- name: Gather Details of Assistant Schedules by ID
  zscaler.zpacloud.zpa_connector_assistant_schedule_info:
    provider: "{{ zpa_cloud }}"
    id: '1'

- name: Gather Details of Assistant Schedules by Customer ID
  zscaler.zpacloud.zpa_connector_assistant_schedule_info:
    provider: "{{ zpa_cloud }}"
    customer_id: "216196257331282583"

Return Values

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

Key

Description

changed

boolean

Indicates if any changes were made.

Returned: always

Sample: false

failed

boolean

Indicates if the operation failed.

Returned: always

Sample: false

schedule

dictionary

Details of the Auto Delete frequency configuration of the App Connector.

Returned: always

customer_id

string

The unique identifier of the ZPA tenant.

Returned: success

Sample: "216199618143191040"

delete_disabled

boolean

Indicates whether the auto deletion feature is disabled.

Returned: success

Sample: true

enabled

boolean

Indicates whether the auto deletion feature is enabled.

Returned: success

Sample: false

frequency

string

The frequency of the auto deletion (e.g., days, weeks).

Returned: success

Sample: "days"

frequency_interval

string

The interval at which the auto deletion occurs.

Returned: success

Sample: "7"

id

string

The unique identifier of the auto deletion schedule.

Returned: success

Sample: "5"

Authors

  • William Guilherme (@willguibr)