zscaler.ziacloud.zia_traffic_forwarding_static_ip module – Adds a static IP address.

Note

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

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Adds a static IP address.

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.

city

dictionary

Specifies the city object associated with the static IP address.

Required if geo_override is enabled and city-level granularity is needed.

id

integer / required

The unique identifier for the city object.

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"

comment

string

Additional information about this static IP address

geo_override

boolean

If not set, geographic coordinates and city are automatically determined from the IP address.

Otherwise, the latitude and longitude coordinates must be provided.

Choices:

  • false

  • true

id

integer

The unique identifier for the static IP address

ip_address

string

The static IP address

latitude

float

Required only if the geoOverride attribute is set.

Latitude with 7 digit precision after decimal point, ranges between -90 and 90 degrees.

longitude

float

Required only if the geoOverride attribute is set.

Longitude with 7 digit precision after decimal point, ranges between -180 and 180 degrees.

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.

routable_ip

boolean

Indicates whether a non-RFC 1918 IP address is publicly routable.

This attribute is ignored if there is no ZIA Private Service Edge associated to the organization.”

Choices:

  • false

  • true

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)

  • "absent"

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.

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete a Static IP.
  zscaler.ziacloud.zia_traffic_forwarding_static_ip:
    provider: '{{ provider }}'
    ip_address: "1.1.1.1"
    routable_ip: true
    comment: "Created with Ansible"
    geo_override: true
    latitude: "-36.848461"
    longitude: "174.763336"

Authors

  • William Guilherme (@willguibr)