zscaler.ziacloud.zia_custom_file_types module – Manages ZIA custom file types

Note

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Creates, updates, or deletes custom file types for File Type Control policies.

  • Custom file types can be configured as rule conditions in different ZIA policies.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

description

string

Additional information about the custom file type.

extension

string

The file type extension. Maximum 10 characters.

id

integer

The unique identifier for the custom file type.

Used to reference an existing custom file type for update or delete.

name

string

The name of the custom file type.

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:

  • "beta"

  • "production"

  • "zscaler"

  • "zscalerbeta"

  • "zscalergov"

  • "zscalerone"

  • "zscalerten"

  • "zscalerthree"

  • "zscalertwo"

  • "zscloud"

  • "zspreview"

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.

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.

  • Use id or name to reference an existing custom file type for update/delete.

Examples

- name: Create a custom file type
  zscaler.ziacloud.zia_custom_file_types:
    provider: '{{ provider }}'
    name: "My Custom Extension"
    description: "Custom file type for internal use"
    extension: "myext"

- name: Update a custom file type by ID
  zscaler.ziacloud.zia_custom_file_types:
    provider: '{{ provider }}'
    id: 1254654
    name: "My Custom Extension Updated"
    description: "Updated description"

- name: Delete a custom file type
  zscaler.ziacloud.zia_custom_file_types:
    provider: '{{ provider }}'
    id: 1254654
    state: absent

Return Values

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

Key

Description

data

dictionary

The custom file type resource record.

Returned: on success

Authors

  • William Guilherme (@willguibr)