paloaltonetworks.panos.panos_edl module – Manage external dynamic lists 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_edl.

New in paloaltonetworks.panos 2.18.0

Synopsis

  • Manage external dynamic lists 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.

certificate_profile

string

PAN-OS 8.0+

Profile for authenticating client certificates

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:

description

string

Descriptive name for this EDL.

device_group

string

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

Default: :ansible-option-default:`"shared"`

edl_type

string

exceptions

list / elements=string

PAN-OS 8.0+

Exceptions.

expand_domain

boolean

PAN-OS 9.0+

Enable/disable expand domain (requires `edl_type=domain`)

Choices:

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 External Dynamic List to create.

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: :ansible-option-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: :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"`

repeat

string

repeat_at

string

The time specification for the given repeat value.

repeat_day_of_month

string

For `repeat=monthly`, the day of the month.

repeat_day_of_week

string

For `repeat=daily`, the day of the week.

source

string

Source.

state

string

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 EDL 'test-edl'
  paloaltonetworks.panos.panos_edl:
    provider: '{{ device }}'
    name: 'test-edl'
    description: 'EDL description'
    edl_type: 'ip'
    source: 'http://1.2.3.4'
    certificate_profile: 'pan-lab-cert-profile'
    repeat: 'hourly'
    state: 'present'

- name: Delete EDL 'test-edl'
  paloaltonetworks.panos.panos_edl:
    provider: '{{ provider }}'
    name: 'test-edl'
    state: 'absent'

Authors

  • Sebastian Czech (@sebastianczech)