zscaler.ziacloud.zia_remote_assistance module – Retrieves information about the Remote Assistance

Note

This module is part of the zscaler.ziacloud collection (version 2.0.3).

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.ziacloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: zscaler.ziacloud.zia_remote_assistance.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal

Requirements

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

Parameters

Parameter

Comments

api_key

string

A string that contains the obfuscated API key.

client_id

string

The client ID for OAuth2 authentication.

client_secret

string

The client secret for OAuth2 authentication.

cloud

string

The Zscaler cloud name provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

device_info_obfuscate

boolean

The rule label name.

Choices:

  • false

  • true

full_access_until

string

The time until when full-access is granted.

Use RFC 1123 format i.e Tue, 15 Apr 2025 12:00:00 UTC

password

string

A string that contains the password for the API admin.

private_key

string

The private key for JWT-based OAuth2 authentication.

provider

dictionary

A dict containing authentication credentials.

api_key

string

Obfuscated API key.

client_id

string

OAuth2 client ID.

client_secret

string

OAuth2 client secret.

cloud

string

Zscaler cloud name.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

  • "beta"

  • "production"

password

string

Password for the API admin.

private_key

string

Private key for OAuth2 JWT.

sandbox_cloud

string

Sandbox Cloud environment.

sandbox_token

string

Sandbox API Key.

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

Email ID of the API admin.

vanity_domain

string

Vanity domain for OAuth2.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

use_legacy_client

boolean

Whether to use the legacy Zscaler API client.

Choices:

  • false ← (default)

  • true

username

string

A string that contains the email ID of the API admin.

username_obfuscated

boolean

The rule label name.

Choices:

  • false

  • true

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

view_only_until

string

The time until when view-only access is granted.

Use RFC 1123 format i.e Tue, 15 Apr 2025 12:00:00 UTC

Notes

Note

  • Check mode is not supported.

Examples

- name: Configure Remote Assistance
  zscaler.ziacloud.zia_remote_assistance:
    provider: '{{ provider }}'
    view_only_until: "Tue, 15 Apr 2025 12:00:00 UTC"
    full_access_until: "Tue, 15 Apr 2025 13:00:00 UTC"
    username_obfuscated: true
    device_info_obfuscate: true

Authors

  • William Guilherme (@willguibr)