paloaltonetworks.panos.panos_tag_object module – Manage tag objects on PAN-OS devices.

Note

This module is part of the paloaltonetworks.panos collection (version 3.1.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 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_tag_object.

New in paloaltonetworks.panos 1.0.0

Synopsis

  • Manage tag objects on PAN-OS devices.

Requirements

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

Parameters

Parameter

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.

color

string

Color for the tag.

Mutually exclusive with color_value.

NOTE that this param is not available for gathered_filter as it is a meta-param.

Choices:

  • "red"

  • "green"

  • "blue"

  • "yellow"

  • "copper"

  • "orange"

  • "purple"

  • "gray"

  • "light green"

  • "cyan"

  • "light gray"

  • "blue gray"

  • "lime"

  • "black"

  • "gold"

  • "brown"

  • "olive"

  • "maroon"

  • "red-orange"

  • "yellow-orange"

  • "forest green"

  • "turquoise blue"

  • "azure blue"

  • "cerulean blue"

  • "midnight blue"

  • "medium blue"

  • "cobalt blue"

  • "violet blue"

  • "blue violet"

  • "medium violet"

  • "medium rose"

  • "lavender"

  • "orchid"

  • "thistle"

  • "peach"

  • "salmon"

  • "magenta"

  • "red violet"

  • "mahogany"

  • "burnt sienna"

  • "chestnut"

color_value

string

The XML value of the color for this tag.

Mutually exclusive with color.

comments

string

Comments for the tag.

commit

boolean

Deprecated

Please use paloaltonetworks.panos.panos_commit_firewall, paloaltonetworks.panos.panos_commit_panorama, paloaltonetworks.panos.panos_commit_push instead.

Commit changes after creating object. If ip_address is a Panorama device, and device_group or template are also set, perform a commit to Panorama and a commit-all to the device group/template.

Choices:

  • false

  • true

device_group

string

(Panorama only) The device group the operation should target.

Default: "shared"

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.

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

string

Name of the tag.

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

Deprecated

Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.

Default: 443

provider

dictionary

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

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: 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: "admin"

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "gathered"

username

string

Deprecated

Use provider to specify PAN-OS connectivity instead.

The username to use for authentication. This is ignored if api_key is specified.

Default: "admin"

vsys

string

The vsys this object belongs to.

Default: "vsys1"

Notes

Note

  • Panorama is supported.

  • Check mode is 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.

Examples

- name: Create tag object 'Prod'
  paloaltonetworks.panos.panos_tag_object:
    provider: '{{ provider }}'
    name: 'Prod'
    color: 'red'
    comments: 'Prod Environment'

- name: Remove tag object 'Prod'
  paloaltonetworks.panos.panos_tag_object:
    provider: '{{ provider }}'
    name: 'Prod'
    state: 'absent'

Authors

  • Michael Richardson (@mrichardson03)