zscaler.ziacloud.zia_traffic_forwarding_gre_tunnels module – GRE tunnel information

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • GRE tunnel information

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"

comment

string

Additional information about this GRE tunnel

id

integer

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

internal_ip_range

string

The start of the internal IP address in /29 CIDR range.

ip_unnumbered

boolean

This is required to support the automated SD-WAN provisioning of GRE tunnels, when set to true gre_tun_ip and gre_tun_id are set to null

Choices:

  • false

  • true

password

string

A string that contains the password for the API admin.

primary_dest_vip_id

list / elements=string

The primary destination data center and virtual IP address (VIP) of the GRE tunnel

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.

secondary_dest_vip_id

list / elements=string

The secondary destination data center and virtual IP address (VIP) of the GRE tunnel

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.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

sub_cloud

string

Restrict the data center virtual IP addresses (VIPs) only to those part of the subcloud

username

string

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

within_country

boolean

Restrict the data center virtual IP addresses (VIPs) only to those within the same country as the source IP address.

Choices:

  • false

  • true

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete GRE Numbered Tunnel.
  zscaler.ziacloud.zia_traffic_forwarding_gre_tunnels:
    provider: '{{ provider }}'
    source_ip: "1.1.1.1"
    comment: "Created with Ansible"
    ip_unnumbered: false
    within_country: false

- name: Create/Update/Delete GRE Unnumbered Tunnel.
  zscaler.ziacloud.zia_traffic_forwarding_gre_tunnels:
    provider: '{{ provider }}'
    source_ip: "1.1.1.1"
    comment: "Created with Ansible"
    ip_unnumbered: true
    within_country: true
    primary_dest_vip:
      - id:
        virtual_ip:
    secondary_dest_vip:
      - id:
        virtual_ip:

Authors

  • William Guilherme (@willguibr)