paloaltonetworks.panos.panos_application_object module – Manage application 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_application_object.

New in paloaltonetworks.panos 2.0.0

Synopsis

  • Manage application objects on PAN-OS devices.

Requirements

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

Parameters

Parameter

Comments

able_to_transfer_file

boolean

Application can do file transfers

Choices:

  • false

  • true

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

string

Application category

consume_big_bandwidth

boolean

Application uses large bandwidth

Choices:

  • false

  • true

data_ident

boolean

Scan for data types

Choices:

  • false

  • true

default_icmp_code

integer

Default ICMP code.

default_icmp_type

integer

Default ICMP type.

default_ip_protocol

string

Default IP protocol.

default_port

list / elements=string

Default ports.

default_type

string

Default identification type of the application.

Choices:

  • "port"

  • "ident-by-ip-protocol"

  • "ident-by-icmp-type"

  • "ident-by-icmp6-type"

description

string

Description of this object

device_group

string

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

Default: "shared"

evasive_behavior

boolean

Application is actively evasive

Choices:

  • false

  • true

file_type_ident

boolean

Scan for files

Choices:

  • false

  • 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_vulnerability

boolean

Application has known vulnerabilities

Choices:

  • false

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

name

string

Name of the tag.

parent_app

string

Parent Application for which this app falls under

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_use

boolean

Application is used pervasively

Choices:

  • false

  • true

port

integer

Deprecated

Use provider to specify PAN-OS connectivity instead.

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

Default: 443

prone_to_misuse

boolean

Application is prone to misuse

Choices:

  • false

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

risk

integer

Risk (1-5) of the application

Choices:

  • 1

  • 2

  • 3

  • 4

  • 5

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "gathered"

subcategory

string

Application subcategory

tag

list / elements=string

Administrative tags

tcp_half_closed_timeout

integer

TCP half closed timeout

tcp_time_wait_timeout

integer

TCP wait time timeout

tcp_timeout

integer

TCP timeout

technology

string

Application technology

timeout

integer

Default timeout

tunnel_applications

list / elements=string

List of tunneled applications

tunnel_other_application

boolean

Application can tunnel other applications

Choices:

  • false

  • true

udp_timeout

integer

UDP timeout

used_by_malware

boolean

Application is used by malware

Choices:

  • false

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

virus_ident

boolean

Scan for viruses

Choices:

  • false

  • true

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 custom application
  paloaltonetworks.panos.panos_application_object:
    provider: '{{ provider }}'
    name: 'custom-app'
    category: 'business-systems'
    subcategory: 'auth-service'
    technology: 'client-server'
    risk: 1

- name: Remove custom application
  paloaltonetworks.panos.panos_application_object:
    provider: '{{ provider }}'
    name: 'custom-app'
    state: 'absent'

Authors

  • Michael Richardson (@mrichardson03)