ansible.builtin.at (v2.3.2.0-1) — module

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

| "added in version" 1.5 of ansible.builtin"

Authors: Richard Isaacson (@risaacson)

preview | supported by core

Install Ansible via pip

Install with pip install ansible==2.3.2.0.post1

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Schedule a command to execute in 20 minutes as root.
- at:
    command: "ls -d / > /dev/null"
    count: 20
    units: minutes
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# Match a command to an existing job and delete the job.
- at:
    command: "ls -d / > /dev/null"
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# 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

Inputs

    
count:
    description:
    - The count of units in the future to execute the command or script file.
    required: true

state:
    choices:
    - present
    - absent
    default: present
    description:
    - The state dictates if the command or script file should be evaluated as present(added)
      or absent(deleted).
    required: false

units:
    choices:
    - minutes
    - hours
    - days
    - weeks
    description:
    - The type of units in the future to execute the command or script file.
    required: true

unique:
    default: false
    description:
    - If a matching job is present a new job will not be added.
    required: false

command:
    default: null
    description:
    - A command to be executed in the future.
    required: false

script_file:
    default: null
    description:
    - An existing script file to be executed in the future.
    required: false