zscaler.ziacloud.zia_cloud_firewall_network_services_groups_info module – Gets a list of all network service groups.

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of all network service groups.

Requirements

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

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

A unique identifier of the network services groups

name

string

The name of the network services groups

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 groups
  zscaler.ziacloud.zia_cloud_firewall_network_services_groups_info:
    provider: '{{ provider }}'

- name: Gather Information Details of a specific network services group
  zscaler.ziacloud.zia_cloud_firewall_network_services_groups_info:
    provider: '{{ provider }}'
    name: "Corporate Custom SSH TCP_10022"

Return Values

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

Key

Description

service_groups

list / elements=dictionary

Information about the network services groups retrieved.

Returned: when successful

creator_context

string

The context in which the network service group was created (e.g., ZIA, user).

Returned: always

Sample: "ZIA"

description

string

A description of the network service group.

Returned: always

Sample: "Corporate Custom SSH TCP_10022"

id

integer

The unique identifier of the network service group.

Returned: always

Sample: 3266248

name

string

The name of the network service group.

Returned: always

Sample: "Corporate Custom SSH TCP_10022"

services

list / elements=dictionary

A list of services included in the group.

Returned: always

id

integer

The unique identifier of the service.

Returned: always

Sample: 1300979

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 service within the group.

Returned: always

Sample: "SSH"

Authors

  • William Guilherme (@willguibr)