paloaltonetworks.panos.panos_device_group module – Manage Panorama device group

Note

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

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

New in paloaltonetworks.panos 2.8.0

Synopsis

  • Manage Panorama device group.

Requirements

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

Parameters

Parameter

Comments

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.

name

string

Name of the device group.

parent

string

Name of the device group parent.

An empty parent means the parent device group should be “shared”.

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:

tag

list / elements=string

List of tags

Notes

Note

  • Panorama is supported.

  • This is a Panorama only module.

  • Check mode is supported.

Examples

# Create a device group under shared.
- name: Create device group
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'hello world'

# Create a device group under "hello world"
- name: Create device group under hello world
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'child'
    parent: 'hello world'

# Delete the child device group
- name: Delete a device group.
  paloaltonetworks.panos.panos_device_group:
    provider: '{{ provider }}'
    name: 'some device group'
    state: 'absent'

Authors

  • Garfield Lee Freeman (@shinmog)