zscaler.zpacloud.zpa_application_segment_by_type_facts module – Retrieves Application Segments Application Segments by Access Type.

Note

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

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will retrieve Application Segments by Access Type

Requirements

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

Parameters

Parameter

Comments

application_type

string / required

The type of application segment.

Choices:

  • "BROWSER_ACCESS"

  • "INSPECT"

  • "SECURE_REMOTE_ACCESS"

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.

name

string

Name of the Application Segment type.

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.

Examples

- name: Get details of a specific BROWSER_ACCESS application segment
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: BROWSER_ACCESS

- name: Get details of a specific BROWSER_ACCESS application segment by name
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: BROWSER_ACCESS
    name: ba_app_segment01

- name: Get details of a specific INSPECT application segment
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: INSPECT

- name: Get details of a specific INSPECT application segment by name
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: INSPECT
    name: inspect_app_segment01

- name: Get details of a specific SECURE_REMOTE_ACCESS application segment
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: SECURE_REMOTE_ACCESS

- name: Get details of a specific SECURE_REMOTE_ACCESS application segment by name
  zscaler.zpacloud.zpa_application_segment_by_type_facts:
    provider: "{{ zpa_cloud }}"
    application_type: SECURE_REMOTE_ACCESS
    name: pra_app_segment01

Authors

  • William Guilherme (@willguibr)