paloaltonetworks.panos.panos_template module – Manage Panorama template

Note

This module is part of the paloaltonetworks.panos collection (version 2.21.2).

To install it, use: ansible-galaxy collection install paloaltonetworks.panos. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: paloaltonetworks.panos.panos_template.

New in paloaltonetworks.panos 2.8.0

Synopsis

• Manage Panorama template.

Requirements

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

• pan-python can be obtained from PyPI https://pypi.python.org/pypi/pan-python

• pandevice can be obtained from PyPI https://pypi.python.org/pypi/pandevice

• pandevice >= 1.5.1

• PANOS >= 7.0

Parameters

Parameter	Comments
default_vsys string	The default vsys in case of a single vsys firewall. Default: :ansible-option-default:`"vsys1"`
description string	The description.
devices list / elements=string	The list of serial numbers in this template.
gathered_filter string	When state=gathered. An advanced filtering option to filter results returned from PAN-OS. Refer to the guide discussing gathered_filter for more information.
mode string	Mode for template.
name string	Name of the template.
provider dictionary / required added in paloaltonetworks.panos 1.0.0	A dict object containing connection details.
api_key string	The API key to use instead of generating it using username / password.
ip_address string / required	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	The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
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	The username to use for authentication. This is ignored if api_key is specified. Default: :ansible-option-default:`"admin"`
state string	The state. Choices: :ansible-option-choices-entry-default:`"present"` ← (default) :ansible-option-choices-entry:`"absent"` :ansible-option-choices-entry:`"replaced"` :ansible-option-choices-entry:`"merged"` :ansible-option-choices-entry:`"deleted"` :ansible-option-choices-entry:`"gathered"`

Notes

Note

• Panorama is supported.

• This is a Panorama only module.

• Check mode is supported.

Examples

# Create a template.
- name: Create template
  paloaltonetworks.panos.panos_template:
    provider: '{{ provider }}'
    name: 'hello world'
    description: 'my description here'
    devices:
      - 90123456
      - 91123456

# Delete a template
- name: Delete a template
  paloaltonetworks.panos.panos_template:
    provider: '{{ provider }}'
    name: 'some template'
    state: 'absent'

Authors

• Garfield Lee Freeman (@shinmog)

Collection links

Issue Tracker Homepage Repository (Sources)