zscaler.zpacloud.zpa_policy_access_rule_reorder module – Triggers the reorder of all policy types.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow for the reorder of all supported policy types.

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 ZPA tenant ID found in the Administration Company menu in the ZPA console.

policy_type

string / required

The name of the supported policy types.

Choices:

  • "access"

  • "timeout"

  • "client_forwarding"

  • "isolation"

  • "inspection"

  • "redirection"

  • "credential"

  • "capabilities"

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.

rules

list / elements=dictionary / required

Contains a list of rule_ids to be reordered with its respective orders.

id

string / required

ID of the rule to be reordered.

order

string / required

The order number of a new or existing rule to be reorder.

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: Reorder Rules
  zscaler.zpacloud.zpa_policy_access_rule_reorder:
    provider: "{{ zpa_cloud }}"
    policy_type: "access"
    rules:
      - id: "216196257331369420"
        order: 1
      - id: "216196257331369421"
        order: 2
      - id: "216196257331369422"
        order: 3

Authors

  • William Guilherme (@willguibr)