zscaler.ziacloud.zia_file_type_control_rules module – Adds a new File Type Control policy rule.

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

New in zscaler.ziacloud 2.0.0

Synopsis

  • Adds a new File Type Control policy rule.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter

Comments

active_content

boolean

Flag to check whether a file has active content or not

Choices:

  • false

  • true

api_key

string

A string that contains the obfuscated API key.

capture_pcap

boolean

Indicates whether packet capture (PCAP) is enabled or not

Choices:

  • false ← (default)

  • true

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"

cloud_applications

list / elements=string

The list of cloud applications to which the File Type Control policy rule must be applied

Use the info resource zia_cloud_applications_info to retrieve the list of supported app_policy and ssl_policy applications

departments

list / elements=integer

Name-ID pairs of departments for which rule will be applied

description

string

Additional information about the rule

device_groups

list / elements=integer

Name-ID pairs of device groups for which the rule must be applied.

This field is applicable for devices that are managed using Zscaler Client Connector.

If no value is set, this field is ignored during the policy evaluation.

device_trust_levels

list / elements=string

List of device trust levels for which the rule must be applied.

This field is applicable for devices that are managed using Zscaler Client Connector.

The trust levels are assigned to the devices based on your posture configurations.

If no value is set, this field is ignored during the policy evaluation.

Choices:

  • "ANY"

  • "UNKNOWN_DEVICETRUSTLEVEL"

  • "LOW_TRUST"

  • "MEDIUM_TRUST"

  • "HIGH_TRUST"

devices

list / elements=integer

Name-ID pairs of devices for which rule must be applied.

Specifies devices that are managed using Zscaler Client Connector.

If no value is set, this field is ignored during the policy evaluation.

enabled

boolean

Determines whether the file type control rule is enabled or disabled

Choices:

  • false

  • true

file_types

list / elements=string

List of URL categories for which rule must be applied

Choices:

  • "ANY"

  • "NONE"

  • "FTCATEGORY_JAVASCRIPT"

  • "FTCATEGORY_FLASH"

  • "FTCATEGORY_JAVA_APPLET"

  • "FTCATEGORY_HTA"

  • "FTCATEGORY_HAR"

  • "FTCATEGORY_ZIP"

  • "FTCATEGORY_GZIP"

  • "FTCATEGORY_TAR"

  • "FTCATEGORY_BZIP2"

  • "FTCATEGORY_RAR"

  • "FTCATEGORY_STUFFIT"

  • "FTCATEGORY_ISO"

  • "FTCATEGORY_CAB"

  • "FTCATEGORY_P7Z"

  • "FTCATEGORY_SCZIP"

  • "FTCATEGORY_DMG"

  • "FTCATEGORY_PKG"

  • "FTCATEGORY_NUPKG"

  • "FTCATEGORY_MF"

  • "FTCATEGORY_EGG"

  • "FTCATEGORY_ALZ"

  • "FTCATEGORY_LZ4"

  • "FTCATEGORY_LZOP"

  • "FTCATEGORY_ZST"

  • "FTCATEGORY_RZIP"

  • "FTCATEGORY_LZIP"

  • "FTCATEGORY_LRZIP"

  • "FTCATEGORY_DACT"

  • "FTCATEGORY_ZPAQ"

  • "FTCATEGORY_BH"

  • "FTCATEGORY_B64"

  • "FTCATEGORY_LZMA"

  • "FTCATEGORY_XZ"

  • "FTCATEGORY_FCL"

  • "FTCATEGORY_ZIPX"

  • "FTCATEGORY_CPIO"

  • "FTCATEGORY_LZH"

  • "FTCATEGORY_MP3"

  • "FTCATEGORY_WAV"

  • "FTCATEGORY_OGG_VORBIS"

  • "FTCATEGORY_M3U"

  • "FTCATEGORY_VPR"

  • "FTCATEGORY_AAC"

  • "FTCATEGORY_ADE"

  • "FTCATEGORY_DB2"

  • "FTCATEGORY_SQL"

  • "FTCATEGORY_EDMX"

  • "FTCATEGORY_FRM"

  • "FTCATEGORY_ACCDB"

  • "FTCATEGORY_DBF"

  • "FTCATEGORY_VIRTUAL_HARD_DISK"

  • "FTCATEGORY_DB"

  • "FTCATEGORY_SDB"

  • "FTCATEGORY_KDBX"

  • "FTCATEGORY_DXL"

  • "FTCATEGORY_WINDOWS_EXECUTABLES"

  • "FTCATEGORY_MICROSOFT_INSTALLER"

  • "FTCATEGORY_WINDOWS_LIBRARY"

  • "FTCATEGORY_WINDOWS_LNK"

  • "FTCATEGORY_PYTHON"

  • "FTCATEGORY_POWERSHELL"

  • "FTCATEGORY_VISUAL_BASIC_SCRIPT"

  • "FTCATEGORY_MSP"

  • "FTCATEGORY_REG"

  • "FTCATEGORY_BAT"

  • "FTCATEGORY_BASH_SCRIPTS"

  • "FTCATEGORY_SHELL_SCRAP"

  • "FTCATEGORY_DEB"

  • "FTCATEGORY_APPX"

  • "FTCATEGORY_MSC"

  • "FTCATEGORY_ELF"

  • "FTCATEGORY_MACH"

  • "FTCATEGORY_DRV"

  • "FTCATEGORY_GBA"

  • "FTCATEGORY_SMD"

  • "FTCATEGORY_XBEH"

  • "FTCATEGORY_PSX"

  • "FTCATEGORY_THREETWOX"

  • "FTCATEGORY_NDS"

  • "FTCATEGORY_BITMAP"

  • "FTCATEGORY_PHOTOSHOP"

  • "FTCATEGORY_WINDOWS_META_FORMAT"

  • "FTCATEGORY_GIF"

  • "FTCATEGORY_JPEG"

  • "FTCATEGORY_PNG"

  • "FTCATEGORY_WEBP"

  • "FTCATEGORY_TIFF"

  • "FTCATEGORY_DCM"

  • "FTCATEGORY_THREEDM"

  • "FTCATEGORY_KML"

  • "FTCATEGORY_JPD"

  • "FTCATEGORY_DNG"

  • "FTCATEGORY_RWZ"

  • "FTCATEGORY_GREENSHOT"

  • "FTCATEGORY_IMG"

  • "FTCATEGORY_HIGH_EFFICIENCY_IMAGE_FILES"

  • "FTCATEGORY_AAF"

  • "FTCATEGORY_OMFI"

  • "FTCATEGORY_PLS"

  • "FTCATEGORY_HLP"

  • "FTCATEGORY_MDZ"

  • "FTCATEGORY_MST"

  • "FTCATEGORY_WINDOWS_SCRIPT_FILES"

  • "FTCATEGORY_GRP"

  • "FTCATEGORY_PIF"

  • "FTCATEGORY_JOB"

  • "FTCATEGORY_PSW"

  • "FTCATEGORY_ONENOTE"

  • "FTCATEGORY_CATALOG"

  • "FTCATEGORY_NETMON"

  • "FTCATEGORY_HIVE"

  • "FTCATEGORY_APK"

  • "FTCATEGORY_IPA"

  • "FTCATEGORY_MOBILECONFIG"

  • "FTCATEGORY_MS_POWERPOINT"

  • "FTCATEGORY_MS_WORD"

  • "FTCATEGORY_MS_EXCEL"

  • "FTCATEGORY_MS_RTF"

  • "FTCATEGORY_MS_MDB"

  • "FTCATEGORY_MS_MSG"

  • "FTCATEGORY_MS_PST"

  • "FTCATEGORY_MS_VSIX"

  • "FTCATEGORY_VSDX"

  • "FTCATEGORY_OAB"

  • "FTCATEGORY_OLM"

  • "FTCATEGORY_MS_PUB"

  • "FTCATEGORY_TNEF"

  • "FTCATEGORY_ENCROFF"

  • "FTCATEGORY_OPEN_OFFICE_DOC"

  • "FTCATEGORY_OPEN_OFFICE_DRAWINGS"

  • "FTCATEGORY_OPEN_OFFICE_PRESENTATIONS"

  • "FTCATEGORY_OPEN_OFFICE_SPREADSHEETS"

  • "FTCATEGORY_ENCRYPT"

  • "FTCATEGORY_PDF_DOCUMENT"

  • "FTCATEGORY_POSTSCRIPT"

  • "FTCATEGORY_COMPILED_HTML_HELP"

  • "FTCATEGORY_DWG"

  • "FTCATEGORY_CGR"

  • "FTCATEGORY_SLDPRT"

  • "FTCATEGORY_TXT"

  • "FTCATEGORY_UNK"

  • "FTCATEGORY_IPT"

  • "FTCATEGORY_XPS"

  • "FTCATEGORY_CSV"

  • "FTCATEGORY_STL"

  • "FTCATEGORY_IQY"

  • "FTCATEGORY_CERT"

  • "FTCATEGORY_INTERNET_SIGNUP"

  • "FTCATEGORY_PCAP"

  • "FTCATEGORY_TTF"

  • "FTCATEGORY_CRX"

  • "FTCATEGORY_CER"

  • "FTCATEGORY_DER"

  • "FTCATEGORY_P7B"

  • "FTCATEGORY_PEM"

  • "FTCATEGORY_JKS"

  • "FTCATEGORY_KEY"

  • "FTCATEGORY_P12"

  • "FTCATEGORY_CHEMDRAW_FILES"

  • "FTCATEGORY_CML"

  • "FTCATEGORY_BPL"

  • "FTCATEGORY_CCC"

  • "FTCATEGORY_CP"

  • "FTCATEGORY_DEVFILE"

  • "FTCATEGORY_MM"

  • "FTCATEGORY_AES"

  • "FTCATEGORY_WOFF2"

  • "FTCATEGORY_STEP_FILES"

  • "FTCATEGORY_RVT"

  • "FTCATEGORY_EMF"

  • "FTCATEGORY_PCD"

  • "FTCATEGORY_INF"

  • "FTCATEGORY_SAM"

  • "FTCATEGORY_PMD"

  • "FTCATEGORY_EOT"

  • "FTCATEGORY_OPENXML"

  • "FTCATEGORY_FODT"

  • "FTCATEGORY_JOBOPTIONS"

  • "FTCATEGORY_IDML"

  • "FTCATEGORY_CXP"

  • "FTCATEGORY_ENEX"

  • "FTCATEGORY_OTF"

  • "FTCATEGORY_LGX"

  • "FTCATEGORY_CBZ"

  • "FTCATEGORY_DPB"

  • "FTCATEGORY_GLB"

  • "FTCATEGORY_PM3"

  • "FTCATEGORY_CD3"

  • "FTCATEGORY_FLN"

  • "FTCATEGORY_IVR"

  • "FTCATEGORY_VU3"

  • "FTCATEGORY_PFB"

  • "FTCATEGORY_WIM"

  • "FTCATEGORY_APPLE_DOCUMENTS"

  • "FTCATEGORY_TABLEAU_FILES"

  • "FTCATEGORY_AUTOCAD"

  • "FTCATEGORY_INTEGRATED_CIRCUIT_FILES"

  • "FTCATEGORY_LOG_FILES"

  • "FTCATEGORY_EML_FILES"

  • "FTCATEGORY_DAT"

  • "FTCATEGORY_INI"

  • "FTCATEGORY_THREED"

  • "FTCATEGORY_THREEDA"

  • "FTCATEGORY_THREEDFA"

  • "FTCATEGORY_THREEDL"

  • "FTCATEGORY_THREEDZ"

  • "FTCATEGORY_APR"

  • "FTCATEGORY_REALFLOW"

  • "FTCATEGORY_COMP"

  • "FTCATEGORY_DDF"

  • "FTCATEGORY_DEM"

  • "FTCATEGORY_THREEDS_MAX"

  • "FTCATEGORY_GSP"

  • "FTCATEGORY_HCL"

  • "FTCATEGORY_MOTION_ANALYSIS"

  • "FTCATEGORY_IGS"

  • "FTCATEGORY_K3D"

  • "FTCATEGORY_LIGHTSCAPE"

  • "FTCATEGORY_AUTODESK_MAYA"

  • "FTCATEGORY_MXS"

  • "FTCATEGORY_OBJ"

  • "FTCATEGORY_SHP"

  • "FTCATEGORY_SPB"

  • "FTCATEGORY_WRL"

  • "FTCATEGORY_TMP"

  • "FTCATEGORY_MUI"

  • "FTCATEGORY_HBS"

  • "FTCATEGORY_ICS"

  • "FTCATEGORY_PUB"

  • "FTCATEGORY_DRAWIO"

  • "FTCATEGORY_PRT"

  • "FTCATEGORY_PS2"

  • "FTCATEGORY_PS3"

  • "FTCATEGORY_ACIS"

  • "FTCATEGORY_VDA"

  • "FTCATEGORY_PARASOLID"

  • "FTCATEGORY_PGP"

  • "FTCATEGORY_BIN"

  • "FTCATEGORY_JSON"

  • "FTCATEGORY_XML"

  • "FTCATEGORY_BINHEX"

  • "FTCATEGORY_QUARKXPRESS"

  • "FTCATEGORY_GO_FILES"

  • "FTCATEGORY_SWIFT_FILES"

  • "FTCATEGORY_RUBY_FILES"

  • "FTCATEGORY_PERL_FILES"

  • "FTCATEGORY_MATLAB_FILES"

  • "FTCATEGORY_INCLUDE_FILES"

  • "FTCATEGORY_JAVA_FILES"

  • "FTCATEGORY_MAKE_FILES"

  • "FTCATEGORY_YAML_FILES"

  • "FTCATEGORY_VISUAL_BASIC_FILES"

  • "FTCATEGORY_C_FILES"

  • "FTCATEGORY_XAML"

  • "FTCATEGORY_BASIC_SOURCE_CODE"

  • "FTCATEGORY_SCT"

  • "FTCATEGORY_A_FILE"

  • "FTCATEGORY_MS_CPP_FILES"

  • "FTCATEGORY_ASM"

  • "FTCATEGORY_BORLAND_CPP_FILES"

  • "FTCATEGORY_CLW"

  • "FTCATEGORY_COBOL"

  • "FTCATEGORY_CSX"

  • "FTCATEGORY_DELPHI"

  • "FTCATEGORY_DMD"

  • "FTCATEGORY_DSP"

  • "FTCATEGORY_F_FILES"

  • "FTCATEGORY_NATVIS"

  • "FTCATEGORY_NCB"

  • "FTCATEGORY_NFM"

  • "FTCATEGORY_POD"

  • "FTCATEGORY_QLIKVIEW_FILES"

  • "FTCATEGORY_RES_FILES"

  • "FTCATEGORY_RPY"

  • "FTCATEGORY_RSP"

  • "FTCATEGORY_SAS"

  • "FTCATEGORY_SC"

  • "FTCATEGORY_SCALA"

  • "FTCATEGORY_SWC"

  • "FTCATEGORY_TCC"

  • "FTCATEGORY_TLH"

  • "FTCATEGORY_TLI"

  • "FTCATEGORY_VISUAL_CPP_FILES"

  • "FTCATEGORY_X1B"

  • "FTCATEGORY_IFC"

  • "FTCATEGORY_BCP"

  • "FTCATEGORY_FOR"

  • "FTCATEGORY_NCI"

  • "FTCATEGORY_AU3"

  • "FTCATEGORY_BGI"

  • "FTCATEGORY_MANIFEST"

  • "FTCATEGORY_NLS"

  • "FTCATEGORY_TLB"

  • "FTCATEGORY_ASHX"

  • "FTCATEGORY_EXP"

  • "FTCATEGORY_FLASH_VIDEO"

  • "FTCATEGORY_AVI"

  • "FTCATEGORY_MPEG"

  • "FTCATEGORY_MP4"

  • "FTCATEGORY_3GPP"

  • "FTCATEGORY_QUICKTIME_VIDEO"

  • "FTCATEGORY_WINDOWS_MEDIA_MOVIE"

  • "FTCATEGORY_MKV"

  • "FTCATEGORY_WEBM"

  • "FTCATEGORY_VS4"

  • "FTCATEGORY_TS"

filtering_action

string

Action taken when traffic matches policy.

This field is not applicable to the Lite API.

Choices:

  • "BLOCK"

  • "CAUTION"

  • "ALLOW"

groups

list / elements=integer

Name-ID pairs of groups for which rule must be applied

id

integer

System generated identifier for a file-type policy

labels

list / elements=integer

The file type control rule label. Rule labels allow you to logically group your organization policy rules.

Policy rules that are not associated with a rule label are grouped under the Untagged label.

location_groups

list / elements=integer

Name-ID pairs of the location groups to which the rule must be applied.

locations

list / elements=integer

Name-ID pairs of locations for which rule must be applied

max_size

integer

Maximum file size (in KB) used for evaluation of the FTP rule

min_size

integer

The minimum file size (in KB) used for evaluation of the DLP policy rule.

name

string / required

Name of the file type control rule

operation

string

File operation performed. This field is not applicable to the Lite API.

Choices:

  • "UPLOAD"

  • "DOWNLOAD"

  • "UPLOAD_DOWNLOAD"

order

integer

Rule order number of the file type control rule

password

string

A string that contains the password for the API admin.

private_key

string

The private key for JWT-based OAuth2 authentication.

protocols

list / elements=string

Protocol criteria

Choices:

  • "ANY_RULE"

  • "SMRULEF_CASCADING_ALLOWED"

  • "FOHTTP_RULE"

  • "FTP_RULE"

  • "SSL_RULE"

  • "HTTPS_RULE"

  • "HTTP_RULE"

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.

rank

integer

Admin rank of the admin who creates this rule

Default: 7

sandbox_cloud

string

The Sandbox cloud environment for API access.

sandbox_token

string

A string that contains the Sandbox API Key.

size_quota

integer

Action must be set to CAUTION

Size quota in MB beyond which the file type control rule is applied.

The allowed range is between 10 MB and 100000 MB

If not set, no quota is enforced. If a policy rule action is set to BLOCK, this field is not applicable.

state

string

Specifies the desired state of the resource.

Choices:

  • "present" ← (default)

  • "absent"

time_quota

integer

Action must be set to CAUTION

Time quota in minutes, after which the file type control rule is applied.

The allowed range is between 15 minutes and 600 minutes.

If not set, no quota is enforced. If a policy rule action is set to BLOCK, this field is not applicable.

time_windows

list / elements=integer

Name-ID pairs of time interval during which rule must be enforced.

unscannable

boolean

Flag to check whether a file is unscannable or not

Choices:

  • false

  • true

url_categories

list / elements=string

The URL categories to which the rule applies

Use the info resource zia_url_categories_info to retrieve the category names.

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.

users

list / elements=integer

Name-ID pairs of users for which rule must be applied

vanity_domain

string

The vanity domain provisioned by Zscaler for OAuth2 flows.

zpa_app_segments

list / elements=dictionary

The list of ZPA Application Segments for which this rule is applicable.

This field is applicable only for the ZPA forwarding method.

external_id

string / required

Indicates the external ID. Applicable only when this reference is of an external entity.

name

string / required

The name of the Application Segment

Notes

Note

  • Check mode is supported.

Examples

- name: Create/Update/Delete a file type control rule.
  zscaler.ziacloud.zia_url_filtering_rules:
    provider: '{{ provider }}'
    name: "URL_Ansible_Example"
    description: "URL_Ansible_Example"
    enabled: "ENABLED"
    action: "ALLOW"
    order: 1
    protocols:
      - "HTTPS_RULE"
      - "HTTP_RULE"
    request_methods:
      - "CONNECT"
      - "DELETE"
      - "GET"
      - "HEAD"
      - "OPTIONS"
      - "OTHER"
      - "POST"
      - "PUT"
      - "TRACE"

Authors

  • William Guilherme (@willguibr)