panos_zone_facts – Retrieves zone information

New in version 2.8.

Synopsis

  • Retrieves information on zones from a firewall or Panorama.

Requirements

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

  • pan-python

  • pandevice

Parameters

Parameter Choices/Defaults Comments
api_key
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The API key to use instead of generating it using username / password.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.
name
-
Name of the security zone.
password
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The password to use for authentication. This is ignored if api_key is specified.
port
integer
Default:
443
Deprecated
Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.
provider
-
added in 2.8
A dict object containing connection details.
api_key
string
The API key to use instead of generating it using username / password.
ip_address
string
The IP address or hostname of the PAN-OS device being configured.
password
string
The password to use for authentication. This is ignored if api_key is specified.
port
integer
Default:
443
The port number to connect to the PAN-OS device on.
serial_number
string
The serial number of a firewall to use for targeted commands. If ip_address is not a Panorama PAN-OS device, then this param is ignored.
username
string
Default:
"admin"
The username to use for authentication. This is ignored if api_key is specified.
template
string
(Panorama only) The template this operation should target. Mutually exclusive with template_stack.
template_stack
string
(Panorama only) The template stack this operation should target. Mutually exclusive with template.
username
string
Default:
"admin"
Deprecated
Use provider to specify PAN-OS connectivity instead.

The username to use for authentication. This is ignored if api_key is specified.
vsys
string
Default:
"vsys1"
The vsys this object belongs to.

Notes

Note

  • Panorama is supported.

  • Check mode is not supported.

  • PAN-OS connectivity should be specified using provider or the classic PAN-OS connectivity params (ip_address, username, password, api_key, and port). If both are present, then the classic params are ignored.

  • If the PAN-OS to be configured is Panorama, either template or template_stack must be specified.

Examples

# Get information on a specific zone
- name: Get zone3 info
  panos_zone_facts:
    provider: '{{ provider }}'
    name: 'zone3'
  register: ans

# Get the config of all zones
- name: Get all zones
  panos_zone_facts:
    provider: '{{ provider }}'
  register: zones

Return Values

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

Key Returned Description
spec
complex
When name is specified.
The spec of the specified virtual router.

  enable_userid
boolean
Enable user identification.

  exclude_acl
list
User identification ACL exclude list.

  include_acl
list
User identification ACL include list.

  interface
list
List of interfaces.

  log_setting
-
Log forwarding setting.

  mode
-
The mode of the zone.

  zone
-
The name.

  zone_profile
-
Zone protection profile.

zones
list
When name is not specified.
List of zone specs.



Status

Authors

  • Garfield Lee Freeman (@shinmog)