zscaler.zpacloud.zpa_application_segment_browser_access_info module – Retrieves browser access application segment information.

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

New in zscaler.zpacloud 1.0.0

Synopsis

• This module will allow the retrieval of information about a browser access application segment.

Requirements

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

• Zscaler SDK Python can be obtained from PyPI https://pypi.org/project/zscaler-sdk-python/

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.
id string	ID of the App Connector Group.
name string	Name of the App Connector Group.
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.

Notes

Note

• Check mode is not supported.

Examples

- name: Gather information about all browser access application segments
  zscaler.zpacloud.zpa_application_segment_browser_access_info:
    provider: "{{ zpa_cloud }}"

- name: Browser Access Application Segment by Name
  zscaler.zpacloud.zpa_application_segment_browser_access_info:
    provider: "{{ zpa_cloud }}"
    name: "Example"

- name: Browser Access Application Segment by ID
  zscaler.zpacloud.zpa_application_segment_browser_access_info:
    provider: "{{ zpa_cloud }}"
    id: "198288282"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
ba_app_segments list / elements=dictionary	Details of the browser access application segments that match the criteria. Returned: always
adp_enabled boolean	Indicates if Advanced Data Protection (ADP) is enabled. Returned: success Sample: false
api_protection_enabled boolean	Indicates if API protection is enabled. Returned: success Sample: false
auto_app_protect_enabled boolean	Indicates if automatic application protection is enabled. Returned: success Sample: false
bypass_on_reauth boolean	Indicates if the application segment bypasses authentication on reauthorization. Returned: success Sample: false
bypass_type string	The type of bypass configured for the application segment. Returned: success Sample: "NEVER"
clientless_apps list / elements=dictionary	List of clientless applications associated with the browser access application segment. Returned: success
allow_options boolean	Indicates if the OPTIONS HTTP method is allowed. Returned: success Sample: false
app_id string	The application ID associated with the clientless app. Returned: success Sample: "216199618143442006"
application_port string	The port number of the application. Returned: success Sample: "443"
application_protocol string	The protocol used by the application. Returned: success Sample: "HTTPS"
certificate_id string	The ID of the certificate associated with the application. Returned: success Sample: "216199618143247243"
certificate_name string	The name of the certificate associated with the application. Returned: success Sample: "jenkins.bd-hashicorp.com"
cname string	The CNAME record associated with the application. Returned: success Sample: "77644.********.h.p.zpa-app.net"
domain string	The domain name of the application. Returned: success Sample: "app01.acme.com"
enabled boolean	Indicates if the clientless app is enabled. Returned: success Sample: true
hidden boolean	Indicates if the clientless app is hidden. Returned: success Sample: false
id string	The unique identifier of the clientless app. Returned: success Sample: "216199618143442007"
name string	The name of the clientless app. Returned: success Sample: "app01.acme.com"
path string	The path associated with the clientless app. Returned: success Sample: "/"
portal boolean	Indicates if the clientless app is a portal. Returned: success Sample: false
trust_untrusted_cert boolean	Indicates if untrusted certificates are trusted. Returned: success Sample: true
config_space string	The configuration space of the application segment. Returned: success Sample: "DEFAULT"
creation_time string	The time when the application segment was created, in epoch format. Returned: success Sample: "1724127537"
description string	A description of the application segment. Returned: success Sample: "app01"
domain_names list / elements=string	A list of domain names associated with the application segment. Returned: success Sample: ["app01.acme.com"]
double_encrypt boolean	Indicates if double encryption is enabled. Returned: success Sample: false
enabled boolean	Indicates if the application segment is enabled. Returned: success Sample: true
fqdn_dns_check boolean	Indicates if FQDN DNS checks are enabled. Returned: success Sample: false
health_check_type string	The type of health check configured for the application segment. Returned: success Sample: "DEFAULT"
health_reporting string	The health reporting mode for the application segment. Returned: success Sample: "ON_ACCESS"
icmp_access_type string	The ICMP access type for the application segment. Returned: success Sample: "NONE"
id string	The unique identifier of the application segment. Returned: success Sample: "216199618143442006"
inspect_traffic_with_zia boolean	Indicates if traffic inspection with ZIA is enabled. Returned: success Sample: false
ip_anchored boolean	Indicates if IP anchoring is enabled. Returned: success Sample: false
is_cname_enabled boolean	Indicates if CNAME is enabled for the application segment. Returned: success Sample: true
is_incomplete_dr_config boolean	Indicates if the application segment has an incomplete disaster recovery configuration. Returned: success Sample: false
match_style string	The match style of the application segment. Returned: success Sample: "EXCLUSIVE"
microtenant_name string	The name of the microtenant associated with the application segment. Returned: success Sample: "Default"
modified_by string	The ID of the user who last modified the application segment. Returned: success Sample: "216199618143191041"
modified_time string	The time when the application segment was last modified, in epoch format. Returned: success Sample: "1724128093"
name string	The name of the application segment. Returned: success Sample: "app01"
passive_health_enabled boolean	Indicates if passive health monitoring is enabled. Returned: success Sample: true
segment_group_id string	The ID of the segment group associated with the application segment. Returned: success Sample: "216199618143442005"
segment_group_name string	The name of the segment group associated with the application segment. Returned: success Sample: "Example200"
select_connector_close_to_app boolean	Indicates if the connector closest to the application should be selected. Returned: success Sample: false
server_groups list / elements=dictionary	A list of server groups associated with the application segment. Returned: success
config_space string	The configuration space of the server group. Returned: success Sample: "DEFAULT"
creation_time string	The time when the server group was created, in epoch format. Returned: success Sample: "1724111999"
dynamic_discovery boolean	Indicates if dynamic discovery is enabled for the server group. Returned: success Sample: true
enabled boolean	Indicates if the server group is enabled. Returned: success Sample: true
id string	The unique identifier of the server group. Returned: success Sample: "216199618143442001"
modified_by string	The ID of the user who last modified the server group. Returned: success Sample: "216199618143191041"
modified_time string	The time when the server group was last modified, in epoch format. Returned: success Sample: "1724111999"
name string	The name of the server group. Returned: success Sample: "Example200"
tcp_keep_alive string	Indicates if TCP keep-alive is enabled for the application segment. Returned: success Sample: "0"
tcp_port_range list / elements=dictionary	A list of TCP port ranges associated with the application segment. Returned: success
from string	The starting port in the range. Returned: success Sample: "443"
to string	The ending port in the range. Returned: success Sample: "443"
tcp_port_ranges list / elements=string	A list of TCP port ranges as strings associated with the application segment. Returned: success Sample: ["443", "443"]
use_in_dr_mode boolean	Indicates if the application segment is used in disaster recovery mode. Returned: success Sample: false
weighted_load_balancing boolean	Indicates if weighted load balancing is enabled. Returned: success Sample: false
changed boolean	Indicates if any changes were made. Returned: always Sample: false
failed boolean	Indicates if the operation failed. Returned: always Sample: false

Authors

• William Guilherme (@willguibr)

Collection links

• Issue Tracker
• Repository (Sources)