W3cubDocs

/Ansible

at - Schedule the execution of a command or script file via the at command.

New in version 1.5.

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 (on host that executes module)

  • at

Options

parameter required default choices comments
command
 no
A command to be executed in the future.
count
 yes
The count of units in the future to execute the command or script file.
script_file
 no
An existing script file to be executed in the future.
state
 no present
  • present
  • absent
The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).
unique
 no
If a matching job is present a new job will not be added.
units
 yes
  • minutes
  • hours
  • days
  • weeks
The type of units in the future to execute the command or script file.

Examples

# Schedule a command to execute in 20 minutes as root.
- at: command="ls -d / > /dev/null" count=20 units="minutes"

# Match a command to an existing job and delete the job.
- at: command="ls -d / > /dev/null" state="absent"

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

This is an Extras Module

For more information on what this means please read Extras Modules

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.

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