Repository files navigation

->Disclaimer: Please refer to ourGeneral Support Statement before proceeding with the use of this collection. You can also refer to ourtroubleshooting guide for guidance on typical problems.

This collection contains modules and plugins to assist in automating the configuration and operational tasks on Zscaler Internet Access cloud, and API interactions with Ansible.

• Free software:MIT License
• Documentation
• Repository
• Example Playbooks

This collection is tested with the most current Ansible releases. Ansible versionsbefore 2.15 arenot supported.

The minimum python version for this collection is python3.9.

The Python module dependencies are not automatically handled byansible-galaxy. To manually install these dependencies, you have the following options:

1. Utilize therequirements.txt file locatedhere to install all required packages:

  pip install -r requirements.txt

2. Alternatively, install theZscaler SDK Python package directly:

  pip install zscaler-sdk-python

Install this collection using the Ansible Galaxy CLI:

ansible-galaxy collection install zscaler.ziacloud

You can also include it in arequirements.yml file and install it viaansible-galaxy collection install -r requirements.yml, using the format:

collections:    -zscaler.ziacloud

It's preferable to use content in this collection using theirFully Qualified Collection Namespace (FQCN), for examplezscaler.ziacloud.zia_cloud_firewall_filtering_rule:

----name:ZIA Cloud Firewall Rulehosts:localhostvars:zia_cloud:username:"{{ lookup('env', 'ZIA_USERNAME') }}"password:"{{ lookup('env', 'ZIA_PASSWORD') }}"api_key:"{{ lookup('env', 'ZIA_API_KEY') }}"cloud:"{{ lookup('env', 'ZIA_CLOUD') | default(omit) }}"tasks:    -name:Create/update firewall filtering rulezscaler.ziacloud.zia_cloud_firewall_filtering_rule:provider:"{{ zia_cloud }}"name:"Ansible Example"description:"Ansible Example"action:"ALLOW"rule_state:"ENABLED"order:1enable_full_logging:truenw_services:          -"774003"          -"774013"register:created_rule    -debug:msg:"{{ created_rule }}"

(Note thatuse of thecollections key is now discouraged)

The intended release frequency for major and minor versions are performed whenever there is a need for fixing issues or to address security concerns.

Changelog details are created automatically and more recently can be foundhere, but also the full history ishere.

Semantic versioning is adhered to for this project.

Deprecations are done by version number, not by date or by age of release. Breaking change deprecations will only be made with major versions.

The Zscaler Internet Access (ZIA) Collection of Ansible Modules iscertified on Ansible Automation Hub and officially supported for Ansible subscribers. Ansible subscribers can engage for support through their usual route towards Red Hat.

For those who are not Ansible subscribers, this Collection of Ansible Modules is alsopublished on Ansible Galaxy and also supported via the formal Zscaler suppport process. Please refer to ourGeneral Support Statement

Copyright (c) 2023Zscaler

Permission is hereby granted, free of charge, to any person obtaining a copyof this software and associated documentation files (the "Software"), to dealin the Software without restriction, including without limitation the rightsto use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software isfurnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in allcopies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS ORIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THEAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHERLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THESOFTWARE.