{"id":19226763,"url":"https://github.com/zscaler/zpacloud-playbooks","last_synced_at":"2025-10-19T01:12:04.741Z","repository":{"id":237109398,"uuid":"793820486","full_name":"zscaler/zpacloud-playbooks","owner":"zscaler","description":"Sample playbooks for the Zscaler Private Access Ansible modules","archived":false,"fork":false,"pushed_at":"2024-09-23T19:42:58.000Z","size":195,"stargazers_count":2,"open_issues_count":0,"forks_count":2,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-04T21:45:54.281Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zscaler.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-04-29T23:41:53.000Z","updated_at":"2024-09-23T19:42:31.000Z","dependencies_parsed_at":"2024-04-30T01:30:53.263Z","dependency_job_id":"0039850e-5f96-4d0e-bc64-b9c9e309dbae","html_url":"https://github.com/zscaler/zpacloud-playbooks","commit_stats":null,"previous_names":["zscaler/zpacloud-playbooks"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zscaler%2Fzpacloud-playbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zscaler%2Fzpacloud-playbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zscaler%2Fzpacloud-playbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zscaler%2Fzpacloud-playbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zscaler","download_url":"https://codeload.github.com/zscaler/zpacloud-playbooks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240300236,"owners_count":19779595,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T15:19:58.555Z","updated_at":"2025-10-19T01:12:04.682Z","avatar_url":"https://github.com/zscaler.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Release](https://github.com/zscaler/zpacloud-playbooks/actions/workflows/release.yml/badge.svg)](https://github.com/zscaler/zpacloud-playbooks/actions/workflows/release.yml)\n[![Ansible Lint](https://github.com/zscaler/zpacloud-playbooks/actions/workflows/ansible-test-lint.yml/badge.svg?branch=master)](https://github.com/zscaler/zpacloud-playbooks/actions/workflows/ansible-test-lint.yml)\n[![License](https://img.shields.io/github/license/zscaler/zpacloud-ansible?color=blue)](https://github.com/zscaler/zpacloud-ansible/v2/blob/master/LICENSE)\n[![Zscaler Community](https://img.shields.io/badge/zscaler-community-blue)](https://community.zscaler.com/)\n\n## Zscaler Support\n\n-\u003e **Disclaimer:** Please refer to our [General Support Statement](https://zscaler.github.io/zpacloud-ansible/support.html) before proceeding with the use of this collection. You can also refer to our [troubleshooting guide](https://zscaler.github.io/zpacloud-ansible/troubleshooting.html) for guidance on typical problems.\n\n# Zscaler Private Access - Ansible Playbooks\n\nExample Ansible playbooks using the Zscaler Private Access\n[Ansible Collection](https://github.com/zscaler/zpacloud-ansible), and what you'll need to get started writing your own. We try to add interesting things to this repository over time based on customer questions, so check back from time to time.\n\n- Free software: MIT License\n- [Documentation](https://zscaler.github.io/zpacloud-ansible)\n- [Repository](https://github.com/zscaler/zpacloud-ansible)\n- [Example Playbooks](https://github.com/zscaler/zpacloud-playbooks)\n\n## Tested Ansible Versions\n\nThis collection is tested with the most current Ansible releases.  Ansible versions\nbefore 2.15 are **not supported**.\n\n## Python Version\n\nThe minimum python version for this collection is python `3.9`.\n\n## Getting Started\n\n### Installing Ansible\n\nFirst, you'll need to install Ansible on the machine that will execute your playbooks (called the control node). The control node can be as simple as a laptop, and can be running any Unix-like OS (Linux, BSD, macOS).\n\nYou'll want to generally follow the\n[Ansible documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation_module.html#installing-the-control-node)\nfor installing Ansible on your machine, but here are quick instructions for popular choices:\n\n#### macOS 10.15\n\nInstall from Pip (Python package manager):\n\n```shell\npip3 install --user ansible\nexport PATH=$PATH:$HOME/Library/Python/3.9/bin\n```\n\n#### CentOS\n\nInstall from [EPEL](https://fedoraproject.org/wiki/EPEL):\n\n```shell\nsudo yum install epel-release\nsudo yum install ansible\n```\n\n#### Ubuntu\n\nInstall from the Ansible PPA:\n\n```shell\nsudo apt update\nsudo apt install software-properties-common\nsudo apt-add-repository --yes --update ppa:ansible/ansible\nsudo apt install ansible\n```\n\nYou'll want to permanently modify the PATH in your shell's config file as well.\n\n## ZPA Ansible Collection Module Installation\n\nInstall this collection using the Ansible Galaxy CLI:\n\n```shell\nansible-galaxy collection install zscaler.zpacloud\n```\n\nYou can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:\n\n```yaml\n  collections:\n    - zscaler.zpacloud\n```\n\n### Clone this repository, install ZPA Collection\n\nOnce you're done with installing Ansible, clone this repo, and install the ZPA collection from Ansible Galaxy as well as the Python modules it depends on:\n\n\n```shell\ngit clone https://github.com/zscaler/zpacloud-playbooks.git\ncd ansible-playbooks/\nansible-galaxy collection install -r collections/requirements.yml\npip3 install --user -r requirements.txt\n```\n\n## Customize Connection Parameters\n\n### Using Credential File\n```sh\n$ ansible-playbook main.yml -e @creds.yml\n```\n\nThe credential file must be in `yaml` format:\n```yml\n  client_id: \"your_client_id\"\n  client_secret: \"your_client_secret\"\n  customer_id: \"your_customer_id\"\n  cloud: \"PRODUCTION\"\n```\n\n### Using Environment Variables - Linux and MacOS\n```sh\n  export ZPA_CLIENT_ID=\"your_client_id\"\n  export ZPA_CLIENT_SECRET=\"your_client_secret\"\n  export ZPA_CUSTOMER_ID=\"your_customer_id\"\n  export ZPA_CLOUD=\"PRODUCTION\"\n```\n\n## Sample Playbooks\n\nYou can use these playbooks as a base by cloning this repository. Each of them is documented with how to run them via\n`ansible-playbook` and their customization options.\n\n## Included content\n\n- [zpa_app_connector_groups](https://zscaler.github.io/zpacloud-ansible/modules/zpa_app_connector_groups_module.html) - Create/Update/Delete an app connector group.\n- [zpa_app_connector_groups_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_app_connector_groups_info_module.html) - Gather information details (ID and/or Name) of a app connector group.\n- [zpa_application_segment](https://zscaler.github.io/zpacloud-ansible/modules/zpa_application_segment_module.html) - Create/Update/Delete an application segment.\n- [zpa_application_segment_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_application_segment_info_module.html) - Gather information details (ID and/or Name) of a application segment.\n- [zpa_application_server](https://zscaler.github.io/zpacloud-ansible/modules/zpa_application_server_module.html) - Create/Update/Delete an Application Server.\n- [zpa_application_server_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_application_server_info_module.html) - Gather information details (ID and/or Name) of an application server.\n- [zpa_ba_certificate_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_ba_certificate_info_module.html) - Gather information details (ID and/or Name) of an browser access certificate.\n- [zpa_cloud_connector_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_cloud_connector_group_info_module.html) - Gather information details (ID and/or Name) of an cloud connector group.\n- [zpa_enrollment_cert_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_enrollment_cert_info_module.html) - Gather information details (ID and/or Name) of an enrollment certificate for use when creating provisioning keys for connector groups or service edge groups.\n- [zpa_idp_controller_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_idp_controller_info_module.html) - Gather information details (ID and/or Name) of an identity provider (IdP) created in the ZPA tenant.\n- [zpa_machine_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_machine_group_info_module.html) - Gather information details (ID and/or Name) of an machine group for use in a policy access and/or forwarding rules.\n- [zpa_policy_access_rule](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_access_rule_module.html) - Create/Update/Delete a policy access rule.\n- [zpa_policy_access_rule_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_access_rule_info_module.html) - Gather information details (ID and/or Name) of a policy access rule.\n- [zpa_policy_access_timeout_rule](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_access_timeout_rule_module.html) - Create/Update/Delete a policy access timeout rule.\n- [zpa_policy_timeout_rule_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_access_timeout_rule_info_module.html) - Gather information details (ID and/or Name) of a policy access timeout rule.\n- [zpa_policy_forwarding_rule](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_access_forwarding_rule_info_module.html) - Create/Update/Delete a policy access forwarding rule.\n- [zpa_policy_forwarding_rule_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_policy_forwarding_rule_info_module.html) - Gather information details (ID and/or Name) of a policy access forwarding rule.\n- [zpa_posture_profile_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_posture_profile_info_module.html) - Gather information details (ID and/or Name) of a posture profile to use in a policy access, timeout or forwarding rules.\n- [zpa_provisioning_key](https://zscaler.github.io/zpacloud-ansible/modules/zpa_provisioning_key_module.html) - Create/Update/Delete a provisioning key.\n- [zpa_provisioning_key_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_provisioning_key_info_module.html) - Gather information details (ID and/or Name) of a provisioning key.\n- [zpa_saml_attribute_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_saml_attribute_info_module.html) - Gather information details (ID and/or Name) of a saml attribute.\n- [zpa_scim_attribute_header_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_scim_attribute_header_info_module.html) - Gather information details (ID and/or Name) of a scim attribute header.\n- [zpa_scim_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_scim_group_info_module.html) - Gather information details (ID and/or Name) of a scim group.\n- [zpa_segment_group](https://zscaler.github.io/zpacloud-ansible/modules/zpa_segment_group_module.html) - Create/Update/Delete a segment group.\n- [zpa_segment_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_segment_group_info_module.html) - Gather information details (ID and/or Name) of a segment group.\n- [zpa_server_group](https://zscaler.github.io/zpacloud-ansible/modules/zpa_server_group_module.html) - Create/Update/Delete a segment group.\n- [zpa_server_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_server_group_info_module.html) - Gather information details (ID and/or Name) of a server group.\n- [zpa_service_edge_group_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_service_edge_groups_info_module.html) - Gather information details (ID and/or Name) of a service edge group.\n- [zpa_service_edge_group](https://zscaler.github.io/zpacloud-ansible/modules/zpa_service_edge_groups_module.html) - Create/Update/Delete an service edge group.\n- [zpa_trusted_network_info](https://zscaler.github.io/zpacloud-ansible/modules/zpa_trusted_networks_info_module.html) - Gather information details (ID and/or Name) of a trusted network for use in a policy access and/or forwarding rules.\n\n## MIT License\n\nCopyright (c) 2023 [Zscaler](https://github.com/zscaler)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzscaler%2Fzpacloud-playbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzscaler%2Fzpacloud-playbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzscaler%2Fzpacloud-playbooks/lists"}