paloaltonetworks.panos.panos_schedule_object module – Manage schedule objects on PAN-OS devices.

Note

This module is part of the paloaltonetworks.panos collection (version 3.2.0).

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

New in paloaltonetworks.panos 2.1.0

Synopsis

  • Manage schedule objects 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.

daily_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a daily recurring schedule

device_group

string

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

Default: "shared"

disable_override

boolean

If the override is disabled

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.

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

non_recurring_date_time

list / elements=string

Date and time range string (e.x. ‘2019/11/01@00:15-2019/11/28@00:30’) for a non-recurring schedule

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

recurrence

string

Recurrence schedule

Choices:

  • "daily"

  • "weekly"

state

string

The state.

Choices:

  • "present" ← (default)

  • "absent"

  • "replaced"

  • "merged"

  • "deleted"

  • "gathered"

type

string

Type of schedule

Choices:

  • "recurring"

  • "non-recurring"

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"

vsys

string

The vsys this object belongs to.

Default: "vsys1"

weekly_friday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Friday)

weekly_monday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Monday)

weekly_saturday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Saturday)

weekly_sunday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Sunday)

weekly_thursday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Thursday)

weekly_tuesday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Tuesday)

weekly_wednesday_time

list / elements=string

Time range (e.x. ‘17:00-19:00’) for a weekly recurring schedule (Wednesday)

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 schedule object
  paloaltonetworks.panos.panos_schedule_object:
    provider: '{{ provider }}'
    name: 'Monday-Work-Day'
    type: 'recurring'
    recurrence: 'weekly'
    weekly_monday_time:
      - '09:00-17:00'

- name: Create non-recurring schedule object
  paloaltonetworks.panos.panos_schedule_object:
    provider: '{{ device }}'
    name: 'Week-of-Sept-21'
    type: 'non-recurring'
    non_recurring_date_time: '2020/09/21@00:15-2020/09/25@17:00'

Authors

  • Michael Richardson (@mrichardson03)