Documentation

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.

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
          

          Status

          This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

          Support

          This module is maintained by those with core commit privileges

          For more information on what this means please read Module Support

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