zscaler.zpacloud.zpa_policy_access_forwarding_rule module – Create a Policy Forwarding Rule.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will create, update or delete a specific Policy Forwarding Rule

Requirements

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

Parameters

Parameter

Comments

action

string

The action of the forwarding rule

Choices:

  • "INTERCEPT"

  • "INTERCEPT_ACCESSIBLE"

  • "BYPASS"

  • "bypass"

  • "intercept"

  • "intercept_accessible"

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"

conditions

list / elements=dictionary

Specifies the set of conditions for the policy rule

operands

list / elements=dictionary

The operands of the condition set

idp_id

string

The unique identifier of the IdP

lhs

string

The key for the object type

object_type

string

The object type of the operand

Choices:

  • "APP"

  • "APP_GROUP"

  • "SAML"

  • "IDP"

  • "SCIM"

  • "SCIM_GROUP"

  • "CLIENT_TYPE"

  • "TRUSTED_NETWORK"

  • "MACHINE_GRP"

  • "POSTURE"

  • "PLATFORM"

  • "BRANCH_CONNECTOR_GROUP"

  • "EDGE_CONNECTOR_GROUP"

rhs

string

The value for the given object type. Its value depends upon the key

operator

string / required

The operator of the condition set

Choices:

  • "AND"

  • "OR"

customer_id

string

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

description

string

The description of the forwarding rule

id

string

The unique identifier of the policy set

name

string / required

The name of the forwarding rule

operator

string

Denotes the operation type. These are operands used between criteria

Choices:

  • "AND"

  • "OR"

policy_type

string

Indicates the policy type. The following value is supported: client_forwarding

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.

rule_order

string

The policy evaluation order number of the rule.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

Notes

Note

  • Check mode is supported.

Examples

- name: Policy Forwarding Rule - Example
  zscaler.zpacloud.zpa_policy_access_forwarding_rule:
    provider: "{{ zpa_cloud }}"
    name: "Policy Forwarding Rule - Example"
    description: "Policy Forwarding Rule - Example"
    action: "BYPASS"
    rule_order: 1
    operator: "AND"
    conditions:
      - operator: "OR"
        operands:
          - name: "app_segment"
            object_type: "APP"
            lhs: "id"
            rhs: "216196257331292105"
      - operator: "OR"
        operands:
          - name: "segment_group"
            object_type: "APP_GROUP"
            lhs: "id"
            rhs: "216196257331292103"
      - operator: "OR"
        operands:
          - name: "zpn_client_type_exporter"
            object_type: "CLIENT_TYPE"
            lhs: "id"
            rhs: "zpn_client_type_exporter"
          - name: "zpn_client_type_browser_isolation"
            object_type: "CLIENT_TYPE"
            lhs: "id"
            rhs: "zpn_client_type_browser_isolation"
          - name: "zpn_client_type_zapp"
            object_type: "CLIENT_TYPE"
            lhs: "id"
            rhs: "zpn_client_type_zapp"
      - operator: "OR"
        operands:
          - name: "CrowdStrike_ZPA_ZTA_80"
            object_type: "POSTURE"
            lhs: "{{ postures.data[0].posture_udid }}"
            rhs: "false"

Authors

  • William Guilherme (@willguibr)