zscaler.ziacloud.zia_cloud_firewall_network_application_group_info module – Gets a list of all network application groups.

Note

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

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

New in zscaler.ziacloud 1.0.0

Synopsis

  • Gets a list of all network application 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 application groups

name

string

The name of the network application 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 application groups
  zscaler.ziacloud.zia_cloud_firewall_network_application_group_info:
    provider: '{{ provider }}'

- name: Gather Information of an Application Group by Name
  zscaler.ziacloud.zia_cloud_firewall_network_application_group_info:
    provider: '{{ provider }}'
    name: "Microsoft Office365"

Return Values

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

Key

Description

app_groups

list / elements=dictionary

List of application groups based on the search criteria provided.

Returned: always

description

string

A description of the application group.

Returned: always

Sample: "Microsoft Office365"

id

integer

The unique identifier for the application group.

Returned: always

Sample: 2577531

name

string

The name of the application group.

Returned: always

Sample: "Microsoft Office365"

network_applications

list / elements=string

List of network applications associated with this group.

Returned: always

Sample: ["YAMMER", "OFFICE365", "SKYPE_FOR_BUSINESS", "OUTLOOK", "SHAREPOINT", "SHAREPOINT_ADMIN", "SHAREPOINT_BLOG", "SHAREPOINT_CALENDAR", "SHAREPOINT_DOCUMENT", "SHAREPOINT_ONLINE", "ONEDRIVE"]

Authors

  • William Guilherme (@willguibr)