at – Schedule the execution of a command or script file via the at command — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# at – Schedule the execution of a command or script file via the at command

- Synopsis
- Requirements
- Parameters
- Examples
- Status

## 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 | Choices/Defaults | Comments
--- | --- | ---
command string |  | A command to be executed in the future.
count integer / required |  | 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 | Choices: absent present ← | The state dictates if the command or script file should be evaluated as present(added) or absent(deleted).
unique boolean | Choices: no ← yes | If a matching job is present a new job will not be added.
units string / required | Choices: minutes hours days weeks | The type of units in the future to execute the command or script file.

## Examples

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

    - name: Match a command to an existing job and delete the job
      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
      at:
        command: ls -d / >/dev/null
        count: 20
        units: minutes
        unique: yes

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Core Team. [core]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Richard Isaacson (@risaacson)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.