zscaler.zpacloud.zpa_application_segment_pra module – Create an PRA application segment in the ZPA Cloud.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will create/update/delete an Privileged Remote Access application segment

Requirements

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

Parameters

Parameter

Comments

bypass_type

string

Indicates whether users can bypass ZPA to access applications.

Choices:

  • "ALWAYS"

  • "NEVER" ← (default)

  • "ON_NET"

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"

common_apps_dto

dictionary / required

Configuration of common applications, e.g., inspection or Browser Access.

apps_config

list / elements=dictionary / required

Detailed configuration for each application.

app_types

list / elements=string / required

This denotes the operation type.

Choices:

  • "BROWSER_ACCESS"

  • "SIPA"

  • "INSPECT"

  • "SECURE_REMOTE_ACCESS"

application_port

string / required

Port for the application.

application_protocol

string / required

Protocol for the application.

Choices:

  • "HTTP"

  • "HTTPS"

  • "FTP"

  • "RDP"

  • "SSH"

  • "WEBSOCKET"

  • "VNC"

  • "NONE"

connection_security

string

The security type of the connection.

Choices:

  • "ANY"

  • "NLA"

  • "NLA_EXT"

  • "TLS"

  • "VM_CONNECT"

  • "RDP"

description

string

The description of the application.

domain

string / required

The domain of the application.

enabled

boolean

Whether the application is enabled.

Choices:

  • false

  • true

name

string / required

The name of the application.

customer_id

string

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

description

string

Description of the application.

domain_names

list / elements=string

List of domains and IPs.

double_encrypt

boolean

Whether Double Encryption is enabled or disabled for the app.

Choices:

  • false

  • true

enabled

boolean

Whether this application is enabled or not.

Choices:

  • false

  • true

health_check_type

string

health check type.

health_reporting

string

Whether health reporting for the app is Continuous or On Access. Supported values are NONE, ON_ACCESS, CONTINUOUS

Choices:

  • "NONE" ← (default)

  • "ON_ACCESS"

  • "CONTINUOUS"

icmp_access_type

boolean

Indicates the ICMP access type.

Choices:

  • false

  • true

id

string

ID of the application.

inspect_traffic_with_zia

boolean

Indicates if Inspect Traffic with ZIA is enabled for the application

When enabled, this leverages a single posture for securing internet/SaaS and private applications

and applies Data Loss Prevention policies to the application segment you are creating

Choices:

  • false

  • true

ip_anchored

boolean

Whether Source IP Anchoring for use with ZIA, is enabled or disabled for the app.

Choices:

  • false

  • true

is_cname_enabled

boolean

Indicates if the Zscaler Client Connector (formerly Zscaler App or Z App) receives CNAME DNS records from the connectors.

Choices:

  • false

  • true

is_incomplete_dr_config

boolean

Indicates whether or not the disaster recovery configuration is incomplete

Choices:

  • false

  • true

name

string / required

Name of the application.

passive_health_enabled

boolean

passive health enabled.

Choices:

  • false

  • true

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.

segment_group_id

string / required

ID of the segment group.

select_connector_close_to_app

boolean

Whether the App Connector is closest to the application (True) or closest to the user (False).

Choices:

  • false

  • true

server_group_ids

list / elements=string / required

ID of the server group.

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

tcp_keep_alive

boolean

Indicates whether TCP communication sockets are enabled or disabled.

Choices:

  • false

  • true

tcp_port_range

list / elements=dictionary

List of tcp port range pairs, e.g. [22, 22] for port 22-22, [80, 100] for 80-100.

from

string

List of valid TCP ports. The application segment API supports multiple TCP and UDP port ranges.

to

string

List of valid TCP ports. The application segment API supports multiple TCP and UDP port ranges.

tcp_port_ranges

list / elements=string

The list of TCP port ranges used to access the application

udp_port_range

list / elements=dictionary

List of udp port range pairs, e.g. [‘35000’, ‘35000’] for port 35000.

from

string

List of valid UDP ports. The application segment API supports multiple TCP and UDP port ranges.

to

string

List of valid UDP ports. The application segment API supports multiple TCP and UDP port ranges.

udp_port_ranges

list / elements=string

The list of UDP port ranges used to access the application

use_in_dr_mode

boolean

Whether or not the application resource is designated for disaster recovery

Choices:

  • false

  • true

Notes

Note

  • Check mode is supported.

Examples

- name: Create an Application Segment PRA
  zscaler.zpacloud.zpa_application_segment_pra:
    provider: "{{ zpa_cloud }}"
    name: Ansible_Application_Segment_PRA
    description: Ansible_Application_Segment_PRA
    enabled: true
    is_cname_enabled: true
    tcp_keep_alive: true
    passive_health_enabled: true
    select_connector_close_to_app: false
    health_check_type: "DEFAULT"
    health_reporting: "ON_ACCESS"
    bypass_type: "NEVER"
    icmp_access_type: false
    tcp_port_range:
      - from: "22"
        to: "22"
      - from: "3389"
        to: "3389"
    domain_names:
      - ssh_pra.example.com
      - rdp_pra.example.com
    segment_group_id: "216196257331368720"
    server_group_ids:
      - "216196257331368722"
    common_apps_dto:
      apps_config:
        - name: "ssh_pra"
          description: "Description for common app"
          domain: ssh_pra.example.com
          application_port: "22"
          application_protocol: "SSH"
          enabled: true
          app_types:
            - "SECURE_REMOTE_ACCESS"
        - name: "rdp_pra"
          description: "Description for common app"
          domain: rdp_pra.example.com
          application_port: "3389"
          application_protocol: "RDP"
          connection_security: "ANY"
          enabled: true
          app_types:
            - "SECURE_REMOTE_ACCESS"

Authors

  • William Guilherme (@willguibr)