• Blog
  • Ansible community forum
  • Documentation
Ansible Logo
Ansible Collections Documentation
Zscaler Private Access Ansible Collection

Getting Started

  • Requirements
  • Installation
  • Authentication
  • Zscaler OneAPI New Framework
  • Legacy API Authentication
  • Examples
  • Module reference
    • zscaler.zpacloud.zpa_app_connector_controller_info module – Retrieves an app connector controller information
    • zscaler.zpacloud.zpa_app_connector_controller module – Manages App Connector Controllers in the ZPA Cloud.
    • zscaler.zpacloud.zpa_app_connector_group_info module – Retrieves an app connector group information
    • zscaler.zpacloud.zpa_app_connector_groups module – Create an App Connector Group in the ZPA Cloud.
    • zscaler.zpacloud.zpa_app_protection_custom_control_info module – Retrieves App Protection Custom Control information.
    • zscaler.zpacloud.zpa_app_protection_predefined_control_info module – Retrieves App Protection Predefined Control information.
    • zscaler.zpacloud.zpa_app_protection_security_profile_info module – Retrieves App Protection Security Profile information.
    • zscaler.zpacloud.zpa_application_segment_ba_v2 module – Create an BA application segment in the ZPA Cloud.
    • zscaler.zpacloud.zpa_application_segment_by_type_info module – Retrieves Application Segments Application Segments by Access Type.
    • zscaler.zpacloud.zpa_application_segment_info module – Retrieve an application segment information.
    • zscaler.zpacloud.zpa_application_segment_inspection module – Create an AppProtection application segment in the ZPA Cloud.
    • zscaler.zpacloud.zpa_application_segment module – Create an application segment in the ZPA Cloud.
    • zscaler.zpacloud.zpa_application_segment_multimatch_bulk_info module – Retrieves unsupported multimatch references for domain names.
    • zscaler.zpacloud.zpa_application_segment_multimatch_bulk module – Bulk update multimatch settings for Application Segments.
    • zscaler.zpacloud.zpa_application_segment_pra module – Create an PRA application segment in the ZPA Cloud.
    • zscaler.zpacloud.zpa_application_segment_weightedlb_config_info module – Retrieves Weighted Load Balancing Config for an Application Segment.
    • zscaler.zpacloud.zpa_application_segment_weightedlb_config module – Manage Weighted Load Balancing Config for an Application Segment.
    • zscaler.zpacloud.zpa_application_server_info module – Retrieve an application server information.
    • zscaler.zpacloud.zpa_application_server module – Create an application server in the ZPA Cloud.
    • zscaler.zpacloud.zpa_ba_certificate_info module – Retrieves browser access certificate information.
    • zscaler.zpacloud.zpa_ba_certificate module – Create certificate in the ZPA Cloud.
    • zscaler.zpacloud.zpa_branch_connector_group_info module – Retrieves Branch Connector Group information.
    • zscaler.zpacloud.zpa_browser_protection_info module – Retrieves Browser Protection Profile information.
    • zscaler.zpacloud.zpa_c2c_ip_ranges_info module – Retrieves information about C2C IP Ranges.
    • zscaler.zpacloud.zpa_c2c_ip_ranges module – Create a C2C IP Range
    • zscaler.zpacloud.zpa_cloud_browser_isolation_banner_info module – Retrieve CBI Banners.
    • zscaler.zpacloud.zpa_cloud_browser_isolation_banner module – Create a Cloud Browser Isolation Banner
    • zscaler.zpacloud.zpa_cloud_browser_isolation_certificate_info module – Retrieve CBI Certificates.
    • zscaler.zpacloud.zpa_cloud_browser_isolation_certificate module – Create a CBI Certificate
    • zscaler.zpacloud.zpa_cloud_browser_isolation_profile_info module – Retrieve CBI Profile.
    • zscaler.zpacloud.zpa_cloud_config_info module – Retrieves ZIA Cloud Config information.
    • zscaler.zpacloud.zpa_cloud_config module – Manages ZIA Cloud Config in ZPA.
    • zscaler.zpacloud.zpa_cloud_connector_group_info module – Retrieves cloud connector group information.
    • zscaler.zpacloud.zpa_connector_assistant_schedule_info module – Gets the Auto Delete frequency of the App Connector.
    • zscaler.zpacloud.zpa_connector_assistant_schedule module – Configures Auto Delete for the specified disconnected App Connector
    • zscaler.zpacloud.zpa_customer_version_profile_info module – Retrieves visible version profiles.
    • zscaler.zpacloud.zpa_enrollement_certificate_info module – Retrieves enrollment certificate information.
    • zscaler.zpacloud.zpa_extranet_resource_partner_info module – Retrieves information about an Extranet Resource Partner.
    • zscaler.zpacloud.zpa_idp_controller_info module – Retrieves Identity Provider information.
    • zscaler.zpacloud.zpa_isolation_profile_info module – Retrieves Isolation Profile information.
    • zscaler.zpacloud.zpa_location_controller_info module – Retrieves information about a Location Controller.
    • zscaler.zpacloud.zpa_location_controller_summary_info module – Retrieves Location Controller summary information.
    • zscaler.zpacloud.zpa_location_group_controller_info module – Retrieves information about a Location Group Controller.
    • zscaler.zpacloud.zpa_lss_client_types_info module – Retrieves Log Streaming Service (LSS) Client Types information from ZPA Cloud.
    • zscaler.zpacloud.zpa_lss_config_controller_info module – Retrieves LSS Config controller information.
    • zscaler.zpacloud.zpa_lss_config_controller module – Create a LSS CONFIG.
    • zscaler.zpacloud.zpa_lss_config_log_types_formats_info module – Retrieves LSS Log formats Information.
    • zscaler.zpacloud.zpa_machine_group_info module – Retrieves machine group information.
    • zscaler.zpacloud.zpa_managed_browser_profile_info module – Retrieves information about a Managed Browser Profile.
    • zscaler.zpacloud.zpa_policy_access_app_protection_rule module – Manage ZPA Access App Protection Policy Rules
    • zscaler.zpacloud.zpa_policy_access_app_protection_rule_v2 module – Manage ZPA Access App Protection Rules (v2)
    • zscaler.zpacloud.zpa_policy_access_forwarding_rule module – Create a Policy Forwarding Rule.
    • zscaler.zpacloud.zpa_policy_access_forwarding_rule_v2 module – Manage ZPA Access Forwarding Rules (v2)
    • zscaler.zpacloud.zpa_policy_access_isolation_rule module – Manage ZPA Access Isolation Policy Rules
    • zscaler.zpacloud.zpa_policy_access_isolation_rule_v2 module – Manage ZPA Access Isolation Rules (v2)
    • zscaler.zpacloud.zpa_policy_access_redirection_rule_v2 module – Manage ZPA Access Redirection Policy Rules
    • zscaler.zpacloud.zpa_policy_access_rule_info module – Retrieves policy access rule information.
    • zscaler.zpacloud.zpa_policy_access_rule module – Create a Policy Access Rule
    • zscaler.zpacloud.zpa_policy_access_rule_reorder module – Triggers the reorder of all policy types.
    • zscaler.zpacloud.zpa_policy_access_rule_v2 module – Manage ZPA Access Policy Rules (v2)
    • zscaler.zpacloud.zpa_policy_access_timeout_rule module – Create a Policy Timeout Rule
    • zscaler.zpacloud.zpa_policy_access_timeout_rule_v2 module – Manage ZPA Access Timeout Policy Rules (v2)
    • zscaler.zpacloud.zpa_policy_capabilities_access_rule_v2 module – Manage ZPA Access Capabilities Policy Rules (v2)
    • zscaler.zpacloud.zpa_policy_credential_access_rule module – Manage ZPA Privileged Credential Access Rules
    • zscaler.zpacloud.zpa_posture_profile_info module – Retrieves details of a posture profile resource.
    • zscaler.zpacloud.zpa_pra_approval_info module – Retrieves information about a PRA Approval.
    • zscaler.zpacloud.zpa_pra_approval module – Create a PRA Approval Controller.
    • zscaler.zpacloud.zpa_pra_console_controller_info module – Retrieves information about a PRA Console.
    • zscaler.zpacloud.zpa_pra_console_controller module – Create a PRA Console Controller.
    • zscaler.zpacloud.zpa_pra_credential_controller_info module – Retrieves information about a PRA Credential.
    • zscaler.zpacloud.zpa_pra_credential_controller module – Create a PRA Credential.
    • zscaler.zpacloud.zpa_pra_credential_pool module – Create a PRA Credential Pool.
    • zscaler.zpacloud.zpa_pra_portal_controller_info module – Retrieves information about a PRA Portal.
    • zscaler.zpacloud.zpa_pra_portal_controller module – Create a PRA Portal Controller.
    • zscaler.zpacloud.zpa_private_cloud_group_info module – Retrieves information about a Private Cloud Group.
    • zscaler.zpacloud.zpa_private_cloud_group module – Create a Private Cloud Group
    • zscaler.zpacloud.zpa_provisioning_key_info module – Retrieves details about a Provisioning Key.
    • zscaler.zpacloud.zpa_provisioning_key module – Create a Provisioning Key.
    • zscaler.zpacloud.zpa_risk_score_values_info module – Retrieves Risk Score Values.
    • zscaler.zpacloud.zpa_saml_attribute_info module – Retrieves saml attributes from a given IDP
    • zscaler.zpacloud.zpa_scim_attribute_header_info module – Retrieves scim attribute header from a given IDP
    • zscaler.zpacloud.zpa_scim_group_info module – Retrieves scim group information from a given IDP
    • zscaler.zpacloud.zpa_segment_group_info module – Retrieves information about a segment group.
    • zscaler.zpacloud.zpa_segment_group module – Create a Segment Group
    • zscaler.zpacloud.zpa_server_group_info module – Retrieves information about an server group
    • zscaler.zpacloud.zpa_server_group module – Create a Server Group
    • zscaler.zpacloud.zpa_service_edge_assistant_schedule_info module – Gets the Auto Delete frequency of the PSE.
    • zscaler.zpacloud.zpa_service_edge_controller_info module – Retrieves a service edge controller information
    • zscaler.zpacloud.zpa_service_edge_controller module – Manages Service Edge Controllers in the ZPA Cloud.
    • zscaler.zpacloud.zpa_service_edge_groups_info module – Retrieves information about a Service Edge Group.
    • zscaler.zpacloud.zpa_service_edge_groups module – Create an Service Edge Group in the ZPA Cloud.
    • zscaler.zpacloud.zpa_trusted_networks_info module – Retrieves information about a Trusted Network.
    • zscaler.zpacloud.zpa_user_portal_aup_info module – Retrieves information about a User Portal Acceptable Use Policy (AUP).
    • zscaler.zpacloud.zpa_user_portal_aup module – Create a User Portal Acceptable Use Policy (AUP)
    • zscaler.zpacloud.zpa_user_portal_controller_info module – Retrieves information about a User Portal Controller.
    • zscaler.zpacloud.zpa_user_portal_controller module – Create a User Portal Controller
    • zscaler.zpacloud.zpa_user_portal_link_info module – Retrieves information about a User Portal Link.
      • Synopsis
      • Requirements
      • Parameters
      • Notes
      • Examples
      • Return Values
        • Authors
        • Collection links
    • zscaler.zpacloud.zpa_user_portal_link module – Create a User Portal Link
    • zscaler.zpacloud.zpa_workload_tag_group_info module – Retrieves information about a Workload Tag Group.
  • Common Return Values

Release Notes

  • Releases

Reference

  • Contributing
  • License

Support Guide

  • Support Guide
  • Troubleshooting Guide
Zscaler Private Access Ansible Collection
  • Module reference
  • zscaler.zpacloud.zpa_user_portal_link_info module – Retrieves information about a User Portal Link.
  • Edit on GitHub

zscaler.zpacloud.zpa_user_portal_link_info module – Retrieves information about a User Portal Link.

Note

This module is part of the zscaler.zpacloud collection (version 2.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_user_portal_link_info.

New in zscaler.zpacloud 1.0.0

  • Synopsis

  • Requirements

  • Parameters

  • Notes

  • Examples

  • Return Values

Synopsis

  • This module will allow the retrieval of information about a User Portal Link.

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 client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

id

string

ID of the User Portal Link.

microtenant_id

string

The unique identifier of the Microtenant for the ZPA tenant.

name

string

Name of the User Portal Link.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

provider

dictionary

A dict containing authentication credentials.

client_id

string

The client ID for OAuth2 authentication.

Required for OneAPI client authentication when use_legacy_client=false.

client_secret

string

The client secret for OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using private_key.

cloud

string

The ZPA cloud provisioned for your organization.

Used for OneAPI client authentication when use_legacy_client=false.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

customer_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

microtenant_id

string

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

Used for OneAPI client authentication when use_legacy_client=false.

private_key

string

The private key for JWT-based OAuth2 authentication.

Used for OneAPI client authentication when use_legacy_client=false and not using client_secret.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

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

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

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

Used for legacy client authentication when use_legacy_client=true.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

When true, uses zpa_client_id/zpa_client_secret/zpa_customer_id/zpa_cloud for authentication.

When false (default), uses client_id/client_secret/private_key with vanity_domain for OAuth2 authentication.

Choices:

  • false ← (default)

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Required for OneAPI client authentication when use_legacy_client=false.

zpa_client_id

string

The ZPA API client ID generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_client_secret

string

The ZPA API client secret generated from the ZPA console.

Required for legacy client authentication when use_legacy_client=true.

zpa_cloud

string

The ZPA cloud provisioned for your organization.

Required for legacy client authentication when use_legacy_client=true.

Choices:

  • "BETA"

  • "GOV"

  • "GOVUS"

  • "PRODUCTION"

  • "QA"

  • "QA2"

  • "PREVIEW"

  • "beta"

  • "production"

zpa_customer_id

string

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

Required for legacy client authentication when use_legacy_client=true.

zpa_microtenant_id

string

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

Used for legacy client authentication when use_legacy_client=true.

Notes

Note

  • Check mode is not supported.

Examples

- name: Get Detail Information of All User Portal Links
  zscaler.zpacloud.zpa_user_portal_link_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a User Portal Link by Name
  zscaler.zpacloud.zpa_user_portal_link_info:
    provider: "{{ zpa_cloud }}"
    name: "server1.example.com"

- name: Get Details of a User Portal Link by ID
  zscaler.zpacloud.zpa_user_portal_link_info:
    provider: "{{ zpa_cloud }}"
    id: "216196257331291969"

Return Values

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

Key

Description

links

list / elements=dictionary

A list of dictionaries containing details about the User Portal Links.

Returned: always

application_id

string

Application ID associated with the User Portal Link.

Returned: success

Sample: "216199618143191041"

creation_time

string

The timestamp when the link was created.

Returned: success

Sample: "1724111641"

description

string

A brief description of the User Portal Link.

Returned: success

Sample: "Portal link for accessing server1"

enabled

boolean

Indicates whether the User Portal Link is enabled.

Returned: success

Sample: true

icon_text

string

Icon text for the User Portal Link.

Returned: success

Sample: ""

id

string

The unique identifier of the User Portal Link.

Returned: success

Sample: "216199618143442000"

link

string

Link URL for the User Portal Link.

Returned: success

Sample: "server1.example.com"

link_path

string

Link path for the User Portal Link.

Returned: success

Sample: ""

microtenant_id

string

The unique identifier of the microtenant associated with the link.

Returned: success

Sample: "216199618143191041"

modified_by

string

The ID of the user who last modified the link.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the link was last modified.

Returned: success

Sample: "1724111641"

name

string

The name of the User Portal Link.

Returned: success

Sample: "server1.example.com"

protocol

string

Protocol for the User Portal Link.

Returned: success

Sample: "https://"

user_portal_id

string

The user portal ID associated with the link.

Returned: success

Sample: "216199618143191041"

user_portals

list / elements=dictionary

List of user portals associated with the link.

Returned: success

enabled

boolean

Whether the user portal is enabled.

Returned: success

Sample: true

id

string

The unique identifier of the user portal.

Returned: success

Sample: "216199618143191041"

name

string

The name of the user portal.

Returned: success

Sample: "UserPortal01"

Authors

  • William Guilherme (@willguibr)

Collection links

  • Issue Tracker
  • Repository (Sources)
Previous Next

© Copyright 2024, Zscaler Inc.