ansible.posix.at module – Schedule the execution of a command or script file via the at command

Note

This module is part of the ansible.posix collection (version 1.5.4).

You might already have this collection installed if you are using the ansible package. 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 ansible.posix. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: ansible.posix.at.

New in ansible.posix 1.0.0

Synopsis

  • Use this module to schedule a command or script file to run once in the future.
  • All jobs are executed in the ‘a’ queue.

Requirements

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

  • at

Parameters

Parameter

Comments

command

string

A command to be executed in the future.

count

integer

The count of units in the future to execute the command or script file.

script_file

string

An existing script file to be executed in the future.

state

string

The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).

Choices:

  • "absent"
  • "present" ← (default)

unique

boolean

If a matching job is present a new job will not be added.

Choices:

  • false ← (default)
  • true

units

string

The type of units in the future to execute the command or script file.

Choices:

  • "minutes"
  • "hours"
  • "days"
  • "weeks"

Examples

- name: Schedule a command to execute in 20 minutes as root
  ansible.posix.at:
    command: ls -d / >/dev/null
    count: 20
    units: minutes

- name: Match a command to an existing job and delete the job
  ansible.posix.at:
    command: ls -d / >/dev/null
    state: absent

- name: Schedule a command to execute in 20 minutes making sure it is unique in the queue
  ansible.posix.at:
    command: ls -d / >/dev/null
    count: 20
    units: minutes
    unique: true

Authors

  • Richard Isaacson (@risaacson)

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/posix/at_module.html