zscaler.ziacloud.zia_cloud_firewall_network_application_info module – Gets a list of all network application 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_application_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

string

The unique identifier for the network application

locale

string

When set to one of the supported locales (i.e., en-US, de-DE, es-ES, fr-FR, ja-JP, zh-CN).

The network application’s description is localized into the requested language.

name

string

The search string used to match against a network application’s description attribute.”

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

- name: Gather Information Details of a Network Applicaction
  zscaler.ziacloud.zia_cloud_firewall_network_application_info:
    provider: '{{ provider }}'
    name: "APNS"

Return Values

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

Key

Description

network_apps

list / elements=dictionary

List of network applications based on the search criteria provided.

Returned: always

deprecated

boolean

Indicates whether the network application is deprecated.

Returned: always

Sample: false

description

string

A description of the network application.

Returned: always

Sample: "APNS_DESC"

id

string

The unique identifier for the network application.

Returned: always

Sample: "APNS"

parent_category

string

The parent category to which the network application belongs.

Returned: always

Sample: "APP_SERVICE"

Authors

  • William Guilherme (@willguibr)