zscaler.ziacloud.zia_cloud_firewall_network_services_info module – Gets a list of all network services.

Note

This module is part of the zscaler.ziacloud collection (version 1.3.1).

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

New in zscaler.ziacloud 1.0.0

Synopsis

• Gets a list of all network services.

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.
cloud string	The Zscaler cloud name was provisioned for your organization. Choices: "zscloud" "zscaler" "zscalerone" "zscalertwo" "zscalerthree" "zscalerbeta" "zscalergov" "zscalerten"
id integer	The unique identifier for the network services
name string	The network services name
password string	A string that contains the password for the API admin.
provider dictionary	A dict object containing connection details. This is optional; credentials can also be provided directly at the top level.
api_key string	A string that contains the obfuscated API key.
cloud string	The Zscaler cloud name was provisioned for your organization. Choices: "zscloud" "zscaler" "zscalerone" "zscalertwo" "zscalerthree" "zscalerbeta" "zscalergov" "zscalerten"
password string	A string that contains the password for the API admin.
sandbox_token string	A string that contains the Sandbox API Key.
username string	A string that contains the email ID of the API admin.
sandbox_token string	A string that contains the Sandbox API Key.
username string	A string that contains the email ID of the API admin.

Notes

Note

• Check mode is not supported.

Examples

- name: Gather Information Details of all Network Services
  zscaler.ziacloud.zia_cloud_firewall_network_services_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a Network Services by Name
  zscaler.ziacloud.zia_cloud_firewall_network_services_info:
    provider: '{{ provider }}'
    name: "ICMP_ANY"

Return Values

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

Key	Description
services list / elements=dictionary	Details about the network services retrieved. Returned: when successful
creator_context string	The context in which the network service was created (e.g., ZIA, user). Returned: always Sample: "ZIA"
description string	Description of the network service. Returned: always Sample: "ICMP_ANY_DESC"
id integer	The unique identifier of the network service. Returned: always Sample: 1300953
is_name_l10n_tag boolean	Indicates if the name of the service is a localization tag. Returned: always Sample: true
name string	The name of the network service. Returned: always Sample: "ICMP_ANY"
tag string	The tag assigned to the network service. Returned: always Sample: "ICMP_ANY"
type string	The type of network service (e.g., STANDARD or CUSTOM). Returned: always Sample: "STANDARD"

Authors

• William Guilherme (@willguibr)

Collection links

• Issue Tracker
• Repository (Sources)