panos_log_forwarding_profile_match_list_action – Manage log forwarding profile match list actions

New in version 2.8.

Synopsis

  • NOTE: The modules in this role are deprecated in favour of the modules in the collection https://paloaltonetworks.github.io/pan-os-ansible

  • Manages log forwarding profile match list actions.

Requirements

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

  • pan-python

  • pandevice >= 0.11.1

Parameters

Parameter Choices/Defaults Comments
action
-
    Choices:
  • add-tag
  • remove-tag
  • Azure-Security-Center-Integration
The action.
action_type
-
    Choices:
  • tagging ←
  • integration
Action type.
api_key
string
Deprecated
Use provider to specify PAN-OS connectivity instead.
The API key to use instead of generating it using username / password.
device_group
string
Default:
"shared"
(Panorama only) The device group the operation should target.
http_profile
-
The HTTP profile when registration=remote.
ip_address
string
Deprecated
Use provider to specify PAN-OS connectivity instead.
The IP address or hostname of the PAN-OS device being configured.
log_forwarding_profile
- / required
Name of the log forwarding profile to add this action to.
log_forwarding_profile_match_list
- / required
Name of the log forwarding profile match list to add this action to.
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.
registration
-
    Choices:
  • localhost
  • panorama
  • remote
Registration.
tags
list
List of tags.
target
-
    Choices:
  • source-address
  • destination-address
The target.
timeout
integer
Valid for PAN-OS 9.0+
Timeout in minutes
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.

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 log forwarding server match list action
- name: Create the action
  panos_log_forwarding_profile_match_list_action:
    provider: '{{ provider }}'
    log_forwarding_profile: 'my-profile'
    log_forwarding_profile_match_list: 'ml-1'
    name: 'my-action'
    action: 'add-tag'
    target: 'source-address'
    registration: 'localhost'
    tags: ['foo', 'bar']
    timeout: 2

Status

Authors

  • Garfield Lee Freeman (@shinmog)