zscaler.ziacloud.zia_dns_gateway module – Adds a new DNS Gateway

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.

New in zscaler.ziacloud 2.0.0

Synopsis

  • Adds a new DNS Gateway

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"

failure_behavior

string

Selects an action that must be performed if the configured DNS service is unavailable or unhealthy

Choices:

  • "FAIL_RET_ERR"

  • "FAIL_ALLOW_IGNORE_DNAT"

  • "FAIL_FORWARD_TO_ZTR"

id

integer

The unique identifier for the rule label.

name

string / required

Name of the DNS Gateway

password

string

A string that contains the password for the API admin.

primary_ip_or_fqdn

string

The IP address or the FQDN of the primary DNS service provided by the third-party DNS service provider

primary_ports

list / elements=string

Lists the ports for the primary DNS server depending on the protocols selected for the gateway.

private_key

string

The private key for JWT-based OAuth2 authentication.

protocols

list / elements=string

Protocols that must be used to connect to the DNS service

Choices:

  • "ANY"

  • "TCP"

  • "UDP"

  • "DOH"

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.

secondary_ip_or_fqdn

string

The IP address or the FQDN of the secondary DNS service provided by the third-party DNS service provider

secondary_ports

list / elements=string

Lists the ports for the secondary DNS server depending on the protocols selected for the gateway.

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 DNS Gateway
  zscaler.ziacloud.zia_dns_gateway:
    name: DNSGatewayAnsible
    primary_ip_or_fqdn: "8.8.8.8"
    secondary_ip_or_fqdn: "4.4.4.4"
    failure_behavior: FAIL_RET_ERR
    protocols:
      - TCP
      - UDP
      - DOH
    primary_ports:
      - "53"
      - "53"
      - "443"
    secondary_ports:
      - "53"
      - "53"
      - "443"

Authors

  • William Guilherme (@willguibr)