zscaler.zpacloud.zpa_connector_assistant_schedule module – Configures Auto Delete for the specified disconnected App Connector

Note

This module is part of the zscaler.zpacloud collection (version 1.4.2).

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.

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will configure Auto Delete for the specified disconnected 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

delete_disabled

boolean

Indicates if the App Connectors are included for deletion if they are in a disconnected state based on frequencyInterval and frequency values

Choices:

  • false

  • true

enabled

boolean

Indicates if the setting for deleting App Connectors is enabled or disabled.

Choices:

  • false

  • true

frequency

string

The scheduled frequency at which the disconnected App Connectors are deleted

Default: "days"

frequency_interval

string

The interval for the configured frequency value. The minimum supported value is 5.

Choices:

  • "5" ← (default)

  • "7"

  • "14"

  • "30"

  • "60"

  • "90"

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.

state

string

The state of the module, which determines if the settings are to be applied.

Choices:

  • "present" ← (default)

Notes

Note

  • Check mode is supported.

Examples

- name: Enable or Update Auto Delete for disconnected App Connector
  zscaler.zpacloud.zpa_connector_assistant_schedule:
    provider: '{{ zpa_cloud }}'
    customer_id: "1234567895452"
    enabled: true
    delete_disabled: true
    frequency: "days"
    frequency_interval: "5"

Authors

  • William Guilherme (@willguibr)