panos_syslog_profile – Manage syslog server profiles

New in version 2.8.

Synopsis

  • Manages syslog server profiles.

Requirements

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

  • pan-python

  • pandevice >= 0.11.1

Parameters

Parameter Choices/Defaults 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.
auth
-
PAN-OS 8.0+
Custom auth log format.
config
-
Custom config log format.
data
-
PAN-OS 8.0+
Custom data log format.
device_group
string
Default:
"shared"
(Panorama only) The device group the operation should target.
escape_character
-
Escape character
escaped_characters
-
Characters to be escaped.
gtp
-
PAN-OS 8.0+
Custom GTP log format.
hip_match
-
Custom HIP match log format.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.

The IP address or hostname of the PAN-OS device being configured.
iptag
-
PAN-OS 9.0+
Custom Iptag log format.
name
- / required
Name of the profile.
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
Default:
443
Deprecated
Use provider to specify PAN-OS connectivity instead.

The port number to connect to the PAN-OS device on.
provider
-
added in 2.8
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
Default:
443
The port number to connect to the PAN-OS device on.
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
Default:
"admin"
The username to use for authentication. This is ignored if api_key is specified.
sctp
-
PAN-OS 8.1+
Custom SCTP log format.
system
-
Custom system log format.
threat
-
Custom threat log format.
traffic
-
Custom traffic log format.
tunnel
-
PAN-OS 8.0+
Custom tunnel log format.
url
-
PAN-OS 8.0+
Custom url log format.
user_id
-
PAN-OS 8.0+
Custom user-ID log format.
username
string
Default:
"admin"
Deprecated
Use provider to specify PAN-OS connectivity instead.

The username to use for authentication. This is ignored if api_key is specified.
vsys
string
Default:
"shared"
The vsys this object belongs to.
wildfire
-
PAN-OS 8.0+
Custom wildfire log format.

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

# Create a profile
- name: Create syslog profile
  panos_syslog_profile:
    provider: '{{ provider }}'
    name: 'my-profile'

Status

Authors

  • Garfield Lee Freeman (@shinmog)