• Blog
  • Ansible community forum
  • Documentation
Ansible Logo
Ansible Collections Documentation
Zscaler Internet Access Ansible Collection

Getting Started

  • Requirements
  • Installation
  • Authentication
  • Zscaler OneAPI New Framework
  • Legacy API Authentication
  • Examples
  • Module reference
    • zscaler.ziacloud.zia_activation_status_info module – Gets the activation status
    • zscaler.ziacloud.zia_activation_status module – Activates the saved configuration changes.
    • zscaler.ziacloud.zia_admin_roles_info module – Gets a list of admin roles
    • zscaler.ziacloud.zia_admin_users_info module – Gets a list of admin users
    • zscaler.ziacloud.zia_advanced_settings_info module – Gets information about the advanced settings configured in the ZIA Admin Portal
    • zscaler.ziacloud.zia_advanced_settings module – Updates the advanced settings configuration in the ZIA Admin Portal
    • zscaler.ziacloud.zia_atp_malicious_urls_info module – Retrieves the malicious URLs added to the denylist in the Advanced Threat Protection (ATP) policy
    • zscaler.ziacloud.zia_atp_malicious_urls module – Updates the malicious URLs added to the denylist in ATP policy
    • zscaler.ziacloud.zia_atp_malware_inspection_info module – Retrieves the traffic inspection configurations of Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_inspection module – Updates the traffic inspection configurations of Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_policy_info module – Retrieves information about the security exceptions configured for the Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_policy module – Updates security exceptions for the Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_protocols_info module – Retrieves the protocol inspection configurations of Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_protocols module – Updates the protocol inspection configurations of Malware Protection policy
    • zscaler.ziacloud.zia_atp_malware_settings_info module – Retrieves the malware protection policy configuration details
    • zscaler.ziacloud.zia_atp_malware_settings module – Updates the malware protection policy configuration details.
    • zscaler.ziacloud.zia_atp_security_exceptions_info module – Retrieves information about the security exceptions configured for the ATP policy
    • zscaler.ziacloud.zia_atp_security_exceptions module – Updates security exceptions for the ATP policy
    • zscaler.ziacloud.zia_atp_settings_info module – Retrieves the advanced threat configuration settings
    • zscaler.ziacloud.zia_atp_settings module – Updates the advanced threat configuration settings
    • zscaler.ziacloud.zia_auth_settings_urls_info module – Gets a list of URLs that were exempted from cookie authentication
      • Synopsis
      • Requirements
      • Parameters
      • Notes
      • Examples
      • Return Values
        • Authors
        • Collection links
    • zscaler.ziacloud.zia_auth_settings_urls module – Adds or removes URLs authentication exempt list.
    • zscaler.ziacloud.zia_authentication_settings_info module – Retrieves the organization’s default authentication settings information
    • zscaler.ziacloud.zia_authentication_settings module – Updates the organization’s default authentication settings
    • zscaler.ziacloud.zia_bandwidth_classes_info module – Retrieves a list of bandwidth classes for an organization
    • zscaler.ziacloud.zia_bandwidth_classes module – Adds a new bandwidth class
    • zscaler.ziacloud.zia_bandwidth_control_rules_info module – Retrieves all the rules in the Bandwidth Control policy.
    • zscaler.ziacloud.zia_bandwidth_control_rules module – Adds a new Bandwidth Control policy rule
    • zscaler.ziacloud.zia_cloud_app_control_rules_info module – Gets the list of cloud application rules by the type of rule..
    • zscaler.ziacloud.zia_cloud_app_control_rules module – Adds a new Cloud App Control rule.
    • zscaler.ziacloud.zia_cloud_application_instances_info module – Retrieves the list of cloud application instances
    • zscaler.ziacloud.zia_cloud_application_instances module – Add a new cloud application instance
    • zscaler.ziacloud.zia_cloud_applications_info module – Retrieves a list of Predefined and User Defined Cloud Applications
    • zscaler.ziacloud.zia_cloud_browser_isolation_profile_info module – Retrieves cloud browser isolation profile.
    • zscaler.ziacloud.zia_cloud_firewall_dns_rules_info module – Retrieves rules in the Cloud Firewall DNS module.
    • zscaler.ziacloud.zia_cloud_firewall_dns_rules module – Firewall DNS policy rule.
    • zscaler.ziacloud.zia_cloud_firewall_ip_destination_groups_info module – Gets a list of all IP destination groups
    • zscaler.ziacloud.zia_cloud_firewall_ip_destination_groups module – Create IP destination groups.
    • zscaler.ziacloud.zia_cloud_firewall_ip_source_groups_info module – Cloud Firewall IP source groups
    • zscaler.ziacloud.zia_cloud_firewall_ip_source_groups module – Cloud Firewall IP source groups
    • zscaler.ziacloud.zia_cloud_firewall_ips_rules_info module – Retrieves the list of IPS Control policy rules
    • zscaler.ziacloud.zia_cloud_firewall_ips_rules module – Firewall Filtering policy IPS rule.
    • zscaler.ziacloud.zia_cloud_firewall_network_application_group_info module – Gets a list of all network application groups.
    • zscaler.ziacloud.zia_cloud_firewall_network_application_group module – Cloud Firewall Network Application Group
    • zscaler.ziacloud.zia_cloud_firewall_network_application_info module – Gets a list of all network application groups.
    • zscaler.ziacloud.zia_cloud_firewall_network_services_groups_info module – Gets a list of all network service groups.
    • zscaler.ziacloud.zia_cloud_firewall_network_services_groups module – Adds a new network service group.
    • zscaler.ziacloud.zia_cloud_firewall_network_services_info module – Gets a list of all network services.
    • zscaler.ziacloud.zia_cloud_firewall_network_services module – Adds a new network service.
    • zscaler.ziacloud.zia_cloud_firewall_rule_info module – Retrieves rules in the Cloud Firewall module.
    • zscaler.ziacloud.zia_cloud_firewall_rule module – Firewall Filtering policy rule.
    • zscaler.ziacloud.zia_cloud_firewall_time_windows_info module – List of time intervals
    • zscaler.ziacloud.zia_device_group_info module – Gets a list of device groups
    • zscaler.ziacloud.zia_devices_info module – Gets a list of devices
    • zscaler.ziacloud.zia_dlp_dictionaries_info module – Custom and predefined DLP dictionaries.
    • zscaler.ziacloud.zia_dlp_dictionaries module – Adds a new custom DLP dictionary.
    • zscaler.ziacloud.zia_dlp_engine_info module – Get a list of DLP engines.
    • zscaler.ziacloud.zia_dlp_engine module – Adds a new custom DLP engine.
    • zscaler.ziacloud.zia_dlp_icap_server_info module – Gets a the list of DLP servers using ICAP.
    • zscaler.ziacloud.zia_dlp_idm_profile_info module – Get IDM template information
    • zscaler.ziacloud.zia_dlp_incident_receiver_info module – Gets a list of DLP Incident Receivers.
    • zscaler.ziacloud.zia_dlp_notification_template_info module – Get a list of DLP notification templates.
    • zscaler.ziacloud.zia_dlp_notification_template module – Manage Zscaler Internet Access (ZIA) DLP Notification Templates
    • zscaler.ziacloud.zia_dlp_web_rules_info module – Gets a list of DLP policy rules, excluding SaaS Security API DLP policy rules
    • zscaler.ziacloud.zia_dlp_web_rules module – Adds a new DLP policy rule
    • zscaler.ziacloud.zia_dns_gateway_info module – Retrieves a list of DNS Gateways
    • zscaler.ziacloud.zia_dns_gateway module – Adds a new DNS Gateway
    • zscaler.ziacloud.zia_end_user_notification_info module – Retrieves browser-based end user notification (EUN)
    • zscaler.ziacloud.zia_end_user_notification module – Retrieves browser-based end user notification (EUN)
    • zscaler.ziacloud.zia_file_type_control_rules_info module – Gets all rules in the Forwarding Control policy.
    • zscaler.ziacloud.zia_file_type_control_rules module – Adds a new File Type Control policy rule.
    • zscaler.ziacloud.zia_forwarding_control_rule_info module – Gets all rules in the Forwarding Control policy.
    • zscaler.ziacloud.zia_forwarding_control_rule module – Forwarding Control policy rule
    • zscaler.ziacloud.zia_ftp_control_policy_info module – Retrieves the FTP Control status and the list of URL categories for which FTP is allowed.
    • zscaler.ziacloud.zia_ftp_control_policy module – Updates the FTP Control settings
    • zscaler.ziacloud.zia_ip_source_anchoring_zpa_gateway_info module – Gets the list of Zscaler Private Access (ZPA) gateways.
    • zscaler.ziacloud.zia_ip_source_anchoring_zpa_gateway module – Manages ZPA Gateways within Zscaler Internet Access
    • zscaler.ziacloud.zia_location_groups_info module – Gets locations only, not sub-locations.
    • zscaler.ziacloud.zia_location_management_info module – Gets locations only, not sub-locations.
    • zscaler.ziacloud.zia_location_management module – Adds new locations and sub-locations.
    • zscaler.ziacloud.zia_mobile_advanced_threat_settings_info module – Retrieves all the rules in the Mobile Malware Protection policy.
    • zscaler.ziacloud.zia_mobile_advanced_threat_settings module – Updates the Mobile Malware Protection rule information
    • zscaler.ziacloud.zia_nat_control_policy_info module – Retrieves a list of all configured and predefined DNAT Control policies.
    • zscaler.ziacloud.zia_nat_control_policy module – Adds a new NAT Control Rule
    • zscaler.ziacloud.zia_nss_servers_info module – Retrieves a list of registered NSS servers
    • zscaler.ziacloud.zia_nss_servers module – Adds a new NSS server.
    • zscaler.ziacloud.zia_remote_assistance_info module – Retrieves information about the Remote Assistance option configured in the ZIA Admin Portal
    • zscaler.ziacloud.zia_remote_assistance module – Retrieves information about the Remote Assistance
    • zscaler.ziacloud.zia_risk_profiles_info module – Retrieves the cloud application risk profile
    • zscaler.ziacloud.zia_risk_profiles module – Adds a new cloud application risk profile
    • zscaler.ziacloud.zia_rule_labels_info module – Gets a list of rule labels
    • zscaler.ziacloud.zia_rule_labels module – Adds a rule label.
    • zscaler.ziacloud.zia_sandbox_advanced_settings_info module – Gets the custom list of MD5 file hashes
    • zscaler.ziacloud.zia_sandbox_advanced_settings module – Manage ZIA Advanced Cloud Sandbox MD5 hash blocklist.
    • zscaler.ziacloud.zia_sandbox_rules_info module – Retrieves the list of all Sandbox policy rules
    • zscaler.ziacloud.zia_sandbox_rules module – Adds a Sandbox policy rule
    • zscaler.ziacloud.zia_sandbox_submission module – Submits a file to the ZIA Advanced Cloud Sandbox for analysis.
    • zscaler.ziacloud.zia_security_policy_settings module – Adds a URL to or removes a URL from the Denylist
    • zscaler.ziacloud.zia_ssl_inspection_rules_info module – Retrieves all SSL inspection rules
    • zscaler.ziacloud.zia_ssl_inspection_rules module – Creates a new SSL inspection rule
    • zscaler.ziacloud.zia_third_party_proxy_service_info module – Retrieves a list of all proxies configured for third-party proxy services
    • zscaler.ziacloud.zia_third_party_proxy_service module – Adds a new object for a third-party proxy service
    • zscaler.ziacloud.zia_traffic_forwarding_gre_internal_ranges_info module – available GRE tunnel internal IP address ranges
    • zscaler.ziacloud.zia_traffic_forwarding_gre_tunnel_info module – Gets the GRE tunnel information for the specified ID
    • zscaler.ziacloud.zia_traffic_forwarding_gre_tunnels module – GRE tunnel information
    • zscaler.ziacloud.zia_traffic_forwarding_static_ip_info module – Gets static IP address for the specified ID
    • zscaler.ziacloud.zia_traffic_forwarding_static_ip module – Adds a static IP address.
    • zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials_info module – Gets VPN credentials that can be associated to locations
    • zscaler.ziacloud.zia_traffic_forwarding_vpn_credentials module – Adds VPN credentials that can be associated to locations.
    • zscaler.ziacloud.zia_url_categories_info module – Gets information about all or custom URL categories.
    • zscaler.ziacloud.zia_url_categories module – Adds a new custom URL category.
    • zscaler.ziacloud.zia_url_filtering_and_cloud_app_settings_info module – Gets the list of cloud application rules by the type of rule..
    • zscaler.ziacloud.zia_url_filtering_and_cloud_app_settings module – Gets the URL Filtering and Cloud App Control settings.
    • zscaler.ziacloud.zia_url_filtering_rule_info module – Gets all url filtering rules.
    • zscaler.ziacloud.zia_url_filtering_rules module – Adds a new URL Filtering rule.
    • zscaler.ziacloud.zia_user_management_department_info module – Gets a list of user departments
    • zscaler.ziacloud.zia_user_management_groups_info module – Gets a list of user groups.
    • zscaler.ziacloud.zia_user_management_info module – Gets a list of users
    • zscaler.ziacloud.zia_workload_groups_info module – Get a list of workload groups.
  • Common Return Values

Release Notes

  • Releases

Reference

  • Contributing
  • License

Support Guide

  • Support Guide
  • Troubleshooting Guide
Zscaler Internet Access Ansible Collection
  • Module reference
  • zscaler.ziacloud.zia_auth_settings_urls_info module – Gets a list of URLs that were exempted from cookie authentication
  • Edit on GitHub

zscaler.ziacloud.zia_auth_settings_urls_info module – Gets a list of URLs that were exempted from cookie authentication

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

New in zscaler.ziacloud 2.0.0

  • Synopsis

  • Requirements

  • Parameters

  • Notes

  • Examples

  • Return Values

Synopsis

  • Gets a list of URLs that were exempted from cookie authentication

Requirements

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

  • Zscaler SDK Python can be obtained from PyPI https://pypi.org/project/zscaler-sdk-python/

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 a list of URLs that were exempted from cookie authentication.
  zscaler.ziacloud.zia_auth_settings_urls_info:
    provider: '{{ provider }}'

Return Values

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

Key

Description

auth

list / elements=string

A list of URLs that were exempted from cookie authentication

Returned: always

Sample: [".newexample.com", ".blocknew.com"]

Authors

  • William Guilherme (@willguibr)

Collection links

  • Issue Tracker
  • Repository (Sources)
Previous Next

© Copyright 2024, Zscaler Inc.