zscaler.ziacloud.zia_ftp_control_policy_info module – Retrieves the FTP Control status and the list of URL categories for which FTP is allowed.

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Retrieves the FTP Control status and the list of URL categories for which FTP is allowed.

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"

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 information about the ftp control policy
  zscaler.ziacloud.zia_ftp_control_policy_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

ftp_settings

dictionary

FTP control policy settings configured in the ZIA Admin Portal.

Returned: always

ftp_enabled

boolean

Indicates whether to enable native FTP.

Returned: always

Sample: true

ftp_over_http_enabled

boolean

Indicates whether to enable FTP over HTTP.

Returned: always

Sample: true

url_categories

list / elements=string

List of URL categories that allow FTP traffic

Returned: always

Sample: ["PROFESSIONAL_SERVICES", "AI_ML_APPS", "GENERAL_AI_ML"]

urls

list / elements=string

Domains or URLs included for the FTP Control settings

Returned: always

Sample: ["test1.acme.com", "test2.acme.com"]

Authors

  • William Guilherme (@willguibr)