ansible.builtin.at (v2.9.27) — module

Install Ansible via pip

Install with pip install ansible==2.9.27

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

• at

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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

Inputs

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

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

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

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

command:
    description:
    - A command to be executed in the future.
    type: str

script_file:
    description:
    - An existing script file to be executed in the future.
    type: str