zscaler.zpacloud.zpa_c2c_ip_ranges_info module – Retrieves information about C2C IP Ranges.

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

New in zscaler.zpacloud 1.0.0

Synopsis

  • This module will allow the retrieval of information about C2C IP Ranges.

  • C2C IP Ranges define the IP address ranges for Client-to-Client connectivity.

Requirements

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

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 C2C IP Range.

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.

name

string

Name of the C2C IP Range.

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 C2C IP Ranges
  zscaler.zpacloud.zpa_c2c_ip_ranges_info:
    provider: "{{ zpa_cloud }}"

- name: Get Details of a C2C IP Range by Name
  zscaler.zpacloud.zpa_c2c_ip_ranges_info:
    provider: "{{ zpa_cloud }}"
    name: "Corporate_Range"

- name: Get Details of a C2C IP Range by ID
  zscaler.zpacloud.zpa_c2c_ip_ranges_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

ranges

list / elements=dictionary

A list of dictionaries containing details about the C2C IP Ranges.

Returned: always

available_ips

string

The number of available IP addresses in the range.

Returned: success

Sample: "254"

country_code

string

Country code for the C2C IP Range location.

Returned: success

Sample: "US"

creation_time

string

The timestamp when the range was created.

Returned: success

Sample: "1724111641"

customer_id

string

The customer ID associated with the range.

Returned: success

Sample: "216199618143191041"

description

string

A brief description of the C2C IP Range.

Returned: success

Sample: "Corporate IP address range"

enabled

boolean

Indicates whether the C2C IP Range is enabled.

Returned: success

Sample: true

id

string

The unique identifier of the C2C IP Range.

Returned: success

Sample: "216199618143442000"

ip_range_begin

string

The beginning IP address of the range.

Returned: success

Sample: "192.168.1.1"

ip_range_end

string

The ending IP address of the range.

Returned: success

Sample: "192.168.1.254"

is_deleted

string

Whether the C2C IP Range has been deleted.

Returned: success

Sample: "false"

latitude_in_db

string

Latitude coordinate stored in the database.

Returned: success

Sample: "37.33874"

location

string

Location description for the IP range.

Returned: success

Sample: "San Jose, CA, USA"

location_hint

string

A hint about the location of the IP range.

Returned: success

Sample: "Created via Ansible"

longitude_in_db

string

Longitude coordinate stored in the database.

Returned: success

Sample: "-121.8852525"

modified_by

string

The ID of the user who last modified the range.

Returned: success

Sample: "216199618143191041"

modified_time

string

The timestamp when the range was last modified.

Returned: success

Sample: "1724111641"

name

string

The name of the C2C IP Range.

Returned: success

Sample: "Corporate_Range"

sccm_flag

boolean

Whether the IP range is flagged for SCCM.

Returned: success

Sample: false

subnet_cidr

string

The subnet CIDR notation for the IP range.

Returned: success

Sample: "192.168.1.0/24"

total_ips

string

The total number of IP addresses in the range.

Returned: success

Sample: "256"

used_ips

string

The number of used IP addresses in the range.

Returned: success

Sample: "2"

Authors

  • William Guilherme (@willguibr)