Fix crontab doc formatting
This commit is contained in:
parent
998e677a9b
commit
a36db3bbef
1 changed files with 7 additions and 10 deletions
17
cron
17
cron
|
@ -25,7 +25,7 @@
|
||||||
# describing the job so that it can be found later, which is required to be
|
# describing the job so that it can be found later, which is required to be
|
||||||
# present in order for this plugin to find/modify the job.
|
# present in order for this plugin to find/modify the job.
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: cron
|
module: cron
|
||||||
short_description: Manage crontab entries.
|
short_description: Manage crontab entries.
|
||||||
|
@ -58,17 +58,14 @@ options:
|
||||||
aliases: []
|
aliases: []
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Whether to ensure the job is present or absent.
|
- Whether to ensure the job is present or absent.
|
||||||
- If the cron_file setting is specified and the state is 'absent', if after the deletion
|
|
||||||
of the job the file is empty, the file is deleted
|
|
||||||
required: false
|
required: false
|
||||||
default: present
|
default: present
|
||||||
aliases: []
|
aliases: []
|
||||||
cron_file:
|
cron_file:
|
||||||
descrition:
|
description:
|
||||||
- The file with appropriate job is created in /etc/cron.d directory. Also, you can store
|
- If specified, uses this file in cron.d versus in the main crontab
|
||||||
multiple jobs in one file.
|
required: false
|
||||||
required: fasle
|
|
||||||
default:
|
default:
|
||||||
aliases: []
|
aliases: []
|
||||||
backup:
|
backup:
|
||||||
|
@ -124,12 +121,12 @@ examples:
|
||||||
description: 'Ensure an old job is no longer present. Removes any job that is preceded by "#Ansible: an old job" in the crontab'
|
description: 'Ensure an old job is no longer present. Removes any job that is preceded by "#Ansible: an old job" in the crontab'
|
||||||
- code: 'cron: name="a job for reboot" reboot=True job="/some/job.sh"'
|
- code: 'cron: name="a job for reboot" reboot=True job="/some/job.sh"'
|
||||||
description: 'Creates an entry like "@reboot /some/job.sh"'
|
description: 'Creates an entry like "@reboot /some/job.sh"'
|
||||||
- code: 'cron: name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate
|
- code: 'cron: name="yum autoupdate" weekday="2" minute=0 hour=12 user="root" job="YUMINTERACTIVE=0 /usr/sbin/yum-autoupdate" cron_file=ansible_yum-autoupdate'
|
||||||
|
|
||||||
requirements: cron
|
requirements: cron
|
||||||
author: Dane Summers
|
author: Dane Summers
|
||||||
updates: Mike Grozak
|
updates: Mike Grozak
|
||||||
'''
|
"""
|
||||||
|
|
||||||
import re
|
import re
|
||||||
import tempfile
|
import tempfile
|
||||||
|
|
Loading…
Reference in a new issue