zscaler.ziacloud.zia_traffic_forwarding_static_ip_info module – Gets static IP address for the specified ID

Note

This module is part of the zscaler.ziacloud collection (version 1.3.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.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_info.

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets static IP address 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

Static IP ID to retrieve

ip_address

string

The static IP address

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.

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 Static IPs.
  zscaler.ziacloud.zia_traffic_forwarding_static_ip_info:
    provider: '{{ provider }}'

- name: Retrieve Details of Specific Static IPs By IP Address.
  zscaler.ziacloud.zia_traffic_forwarding_static_ip_info:
    provider: '{{ provider }}'
    ip_address: 1.1.1.1

- name: Retrieve Details of Specific Static IPs By ID.
  zscaler.ziacloud.zia_traffic_forwarding_static_ip_info:
    provider: '{{ provider }}'
    id: 82709

Return Values

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

Key

Description

static_ips

list / elements=dictionary

A list of Static IP configuration details retrieved.

Returned: always

city

dictionary

Details about the city associated with the Static IP.

Returned: always

id

integer

The unique identifier for the city.

Returned: always

Sample: 3448439

name

string

The name of the city, including additional location details.

Returned: always

Sample: "California, san Jose, United States"

geo_override

boolean

Indicates if the geolocation has been manually overridden.

Returned: always

Sample: false

id

integer

The unique identifier for the Static IP.

Returned: always

Sample: 3687136

ip_address

string

The IP address of the Static IP configuration.

Returned: always

Sample: "1.1.1.1"

last_modification_time

integer

The Unix timestamp when the Static IP was last modified.

Returned: always

Sample: 1721348015

last_modified_by

dictionary

Information about the user who last modified the Static IP.

Returned: always

id

integer

The unique identifier of the user who last modified the entry.

Returned: always

Sample: 44772836

name

string

The username of the person who last modified the entry.

Returned: always

Sample: "DEFAULT ADMIN"

latitude

float

The latitude coordinate of the Static IP.

Returned: always

Sample: -23.6283

longitude

float

The longitude coordinate of the Static IP.

Returned: always

Sample: -46.6409

routable_ip

boolean

Specifies if the IP address is routable on the Internet.

Returned: always

Sample: true

Authors

  • William Guilherme (@willguibr)