zscaler.ziacloud.zia_traffic_forwarding_gre_tunnel_info module – Gets the GRE tunnel information for the specified ID

Note

This module is part of the zscaler.ziacloud 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.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_traffic_forwarding_gre_tunnel_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets the GRE tunnel information for the specified ID.

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.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

id

integer

Unique identifier of the static IP address that is associated to a GRE tunnel

password

string

A string that contains the password for the API admin.

provider

dictionary

A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.

api_key

string

A string that contains the obfuscated API key.

cloud

string

The Zscaler cloud name was provisioned for your organization.

Choices:

  • "zscloud"

  • "zscaler"

  • "zscalerone"

  • "zscalertwo"

  • "zscalerthree"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerten"

password

string

A string that contains the password for the API admin.

sandbox_token

string

A string that contains the Sandbox API Key.

username

string

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

sandbox_token

string

A string that contains the Sandbox API Key.

source_ip

string

The source IP address of the GRE tunnel.

This is typically a static IP address in the organization or SD-WAN.

This IP address must be provisioned within the Zscaler service using the /staticIP endpoint.

username

string

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

Notes

Note

  • Check mode is not supported.

Examples

- name: Retrieve Details of All GRE Tunnels.
  zscaler.ziacloud.zia_traffic_forwarding_gre_tunnel_info:
    provider: '{{ provider }}'

- name: Retrieve Details of Specific GRE Tunnel By Source IP Address.
  zscaler.ziacloud.zia_traffic_forwarding_gre_tunnel_info:
    provider: '{{ provider }}'
    source_ip: 1.1.1.1

- name: Retrieve Details of Specific GRE Tunnel By ID.
  zscaler.ziacloud.zia_traffic_forwarding_gre_tunnel_info:
    provider: '{{ provider }}'
    id: 82709

Return Values

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

Key

Description

gre_tunnels

list / elements=dictionary

A list of GRE tunnel configurations retrieved from the ZIA platform.

Returned: always

comment

string

User-provided comments about the GRE tunnel.

Returned: always

Sample: "GRE Tunnel Example"

id

integer

The unique identifier for the GRE tunnel.

Returned: always

Sample: 3687136

internal_ip_range

string

Internal IP range configured for the GRE tunnel.

Returned: always

Sample: "172.19.48.72"

ip_unnumbered

boolean

Flag indicating if the tunnel uses unnumbered IP.

Returned: always

Sample: false

last_modification_time

integer

Unix timestamp of when the GRE tunnel configuration was last modified.

Returned: always

Sample: 1721348656

last_modified_by

dictionary

Details of the user who last modified the GRE tunnel configuration.

Returned: always

id

integer

Unique identifier of the user.

Returned: always

Sample: 44772836

name

string

Name of the user.

Returned: always

Sample: "DEFAULT ADMIN"

primary_dest_vip

dictionary

Primary destination virtual IP configuration for the GRE tunnel.

Returned: always

city

string

City of the primary destination.

Returned: always

Sample: "Sao Paulo"

country_code

string

Country code of the primary destination.

Returned: always

Sample: "US"

datacenter

string

Datacenter where the primary VIP is located.

Returned: always

Sample: "SAO4"

id

integer

Unique identifier of the primary destination.

Returned: always

Sample: 79439

latitude

float

Latitude of the primary destination.

Returned: always

Sample: -22.0

longitude

float

Longitude of the primary destination.

Returned: always

Sample: -47.0

virtual_ip

string

Virtual IP address of the primary destination.

Returned: always

Sample: "147.161.128.23"

secondary_dest_vip

dictionary

Secondary destination virtual IP configuration for the GRE tunnel.

Returned: always

city

string

City of the secondary destination.

Returned: always

Sample: "Rio de Janeiro"

country_code

string

Country code of the secondary destination.

Returned: always

Sample: "BR"

datacenter

string

Datacenter where the secondary VIP is located.

Returned: always

Sample: "RIO1"

id

integer

Unique identifier of the secondary destination.

Returned: always

Sample: 205298

latitude

float

Latitude of the secondary destination.

Returned: always

Sample: -23.0

longitude

float

Longitude of the secondary destination.

Returned: always

Sample: -43.0

virtual_ip

string

Virtual IP address of the secondary destination.

Returned: always

Sample: "170.85.16.65"

source_ip

string

The source IP address used by the GRE tunnel.

Returned: always

Sample: "1.1.1.1"

Authors

  • William Guilherme (@willguibr)