zscaler.ziacloud.zia_dns_gateway_info module – Retrieves a list of DNS Gateways

Note

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

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves a list of DNS Gateways

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.

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"

id

integer

The unique identifier for the DNS Gateway

name

string

The DNS Gateway name.

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.

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

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 not supported.

Examples

- name: Gets a list of all DNS Gateways
  zscaler.ziacloud.zia_dns_gateway_info:
    provider: '{{ provider }}'

- name: Gets the DNS Gateway by name
  zscaler.ziacloud.zia_dns_gateway_info:
    provider: '{{ provider }}'
    name: "DNSGW01"

- name: Gets the DNS Gateway by ID
  zscaler.ziacloud.zia_dns_gateway_info:
    provider: '{{ provider }}'
    id: 97687667

Return Values

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

Key

Description

gateways

list / elements=dictionary

A list of DNS Gateways fetched based on the given criteria.

Returned: always

auto_created

boolean

Indicates whether the DNS Gateway was automatically created.

Returned: always

Sample: false

dns_gateway_type

string

The type of DNS Gateway. Typically defaults to `OFW_PDNS_REDIR_GW`.

Returned: always

Sample: "OFW_PDNS_REDIR_GW"

failure_behavior

string

Action to perform if the configured DNS service is unavailable or unhealthy.

Returned: always

Sample: "FAIL_RET_ERR"

id

integer

The unique identifier for the DNS Gateway.

Returned: always

Sample: 18442171

name

string

The name of the DNS Gateway.

Returned: always

Sample: "DNSGatewayAnsible"

nat_ztr_gateway

boolean

Indicates whether the gateway uses NAT with Zscaler Trusted Resolver.

Returned: always

Sample: false

primary_ip_or_fqdn

string

IP address or FQDN of the primary DNS service provided by your DNS service provider.

Returned: always

Sample: "8.8.8.8"

primary_ports

list / elements=string

List of ports used to connect to the primary DNS service.

Returned: always

Sample: ["53", "53", "443"]

protocols

list / elements=string

Protocols used to connect to the DNS service.

Returned: always

Sample: ["TCP", "UDP", "DOH"]

secondary_ip_or_fqdn

string

IP address or FQDN of the secondary DNS service provided by your DNS service provider.

Returned: always

Sample: "4.4.4.4"

secondary_ports

list / elements=string

List of ports used to connect to the secondary DNS service.

Returned: always

Sample: ["53", "53", "443"]

Authors

  • William Guilherme (@willguibr)