paloaltonetworks.panos.panos_application_filter module – Manage application filters on PAN-OS devices.

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

New in paloaltonetworks.panos 2.1.0

Synopsis

• Manage application filters on PAN-OS devices.

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

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.
category list / elements=string	Application category
device_group string	(Panorama only) The device group the operation should target. Default: :ansible-option-default:`"shared"`
evasive boolean	If the applications are evasive Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
excessive_bandwidth_use boolean	If the applications use excessive bandwidth Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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.
has_known_vulnerabilities boolean	If the applications have known vulnerabilities Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
ip_address string	Deprecated Use provider to specify PAN-OS connectivity instead. The IP address or hostname of the PAN-OS device being configured.
is_saas boolean	If the applications are SaaS Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
name string	Name of the object.
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.
pervasive boolean	If the applications are used pervasively Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
port integer	Deprecated Use provider to specify PAN-OS connectivity instead. The port number to connect to the PAN-OS device on. Default: :ansible-option-default:`443`
prone_to_misuse boolean	If the applications are prone to misuse Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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: :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"`
risk list / elements=string	Risk (1-5) of the application Choices: :ansible-option-choices-entry:`"1"` :ansible-option-choices-entry:`"2"` :ansible-option-choices-entry:`"3"` :ansible-option-choices-entry:`"4"` :ansible-option-choices-entry:`"5"`
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"`
subcategory list / elements=string	Application subcategory
tag list / elements=string	Administrative tags
technology list / elements=string	Application technology
transfers_files boolean	If the applications transfer files Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
tunnels_other_apps boolean	If the applications tunnel other applications Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
used_by_malware boolean	If the applications are used by malware Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
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: :ansible-option-default:`"admin"`
vsys string	The vsys this object belongs to. Default: :ansible-option-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 application filter
  paloaltonetworks.panos.panos_application_filter:
    provider: '{{ provider }}'
    name: 'custom-apps'
    category: ['business-systems']
    subcategory: ['auth-service']
    technology: ['client-server']
    risk: ['1']

- name: Remove custom application
  paloaltonetworks.panos.panos_application_filter:
    provider: '{{ provider }}'
    name: 'custom-apps'
    state: 'absent'

Authors

• Michael Richardson (@mrichardson03)

Collection links

Issue Tracker Homepage Repository (Sources)