ansible/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
Code Releases Activity

Fixes to documentation

Browse source
This commit is contained in:
Dag Wieers 2012-10-09 12:42:10 +02:00
parent 4bd17ee518
commit 98624cb394
2 changed files with 25 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
library/cron
View file

@ -31,9 +31,9 @@ short_description: Manage crontab entries.
description: description:
- Use this module to manage crontab entries. This module allows you to create named - Use this module to manage crontab entries. This module allows you to create named
crontab entries, update, or delete them. crontab entries, update, or delete them.
- The module include one line with the description of the crontab entry "#Ansible: <name>" - 'The module include one line with the description of the crontab entry "#Ansible: <name>"
corresponding to the 'name' passed to the module, which is used by future ansible/module calls corresponding to the "name" passed to the module, which is used by future ansible/module calls
to find/check the state. to find/check the state.'
version_added: "0.9" version_added: "0.9"
options: options:
name: name:
@ -72,37 +72,37 @@ options:
description: description:
- Minute when the job should run ( 0-59, *, */2, etc ) - Minute when the job should run ( 0-59, *, */2, etc )
required: false required: false
default: * default: "*"
aliases: [] aliases: []
hour: hour:
description: description:
- Hour when the job should run ( 0-23, *, */2, etc ) - Hour when the job should run ( 0-23, *, */2, etc )
required: false required: false
default: * default: "*"
aliases: [] aliases: []
day: day:
description: description:
- Day of the month the job should run ( 1-31, *, */2, etc ) - Day of the month the job should run ( 1-31, *, */2, etc )
required: false required: false
default: * default: "*"
aliases: [] aliases: []
month: month:
description: description:
- Month of the year the job should run ( 1-12, *, */2, etc ) - Month of the year the job should run ( 1-12, *, */2, etc )
required: false required: false
default: * default: "*"
aliases: [] aliases: []
weekday: weekday:
description: description:
- Day of the week that the job should run ( 0-7 for Sunday - Saturday, or mon, tue, * etc ) - Day of the week that the job should run ( 0-7 for Sunday - Saturday, or mon, tue, * etc )
required: false required: false
default: * default: "*"
aliases: [] aliases: []
examples: examples:
- code: cron name="check dirs" hour="5,2" job="ls -alh > /dev/null" - code: cron name="check dirs" hour="5,2" job="ls -alh > /dev/null"
description: Ensure a job that runs at 2 and 5 exists. Creates an entry like "* 5,2 * * ls -alh > /dev/null" description: Ensure a job that runs at 2 and 5 exists. Creates an entry like "* 5,2 * * ls -alh > /dev/null"
- code: name="an old job" cron job="/some/dir/job.sh" state=absent - code: name="an old job" cron job="/some/dir/job.sh" state=absent
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'
requirements: cron requirements: cron
author: Dane Summers author: Dane Summers
''' '''

20
library/hpilo_boot
View file

@ -24,8 +24,8 @@ author: Dag Wieers
module: hpilo_boot module: hpilo_boot
short_description: Boot system using specific media through HP iLO interface short_description: Boot system using specific media through HP iLO interface
description: description:
- This module boots a system through its HP iLO interface. The boot media - 'This module boots a system through its HP iLO interface. The boot media
can be one of: cdrom, floppy, hdd, network or usb. can be one of: cdrom, floppy, hdd, network or usb.'
- This module requires the hpilo python module. - This module requires the hpilo python module.
version_added: "0.8" version_added: "0.8"
options: options:
@ -57,20 +57,20 @@ options:
choices: [ "cdrom", "floppy", "hdd", "network", "normal", "usb" ] choices: [ "cdrom", "floppy", "hdd", "network", "normal", "usb" ]
image: image:
description: description:
- The URL of a cdrom, floppy or usb boot media image. - "The URL of a cdrom, floppy or usb boot media image.
C(protocol://username:password@hostname:port/filename) C(protocol://username:password@hostname:port/filename)"
- protocol is either C(http) or C(https) - protocol is either C(http) or C(https)
- username:password is optional - "username:password is optional"
- port is optional - port is optional
required: false required: false
state: state:
description: description:
- The state of the boot media. - The state of the boot media.
- no_boot: Do not boot from the device - "no_boot: Do not boot from the device"
- boot_once: Boot from the device once and then notthereafter - "boot_once: Boot from the device once and then notthereafter"
- boot_always: Boot from the device each time the serveris rebooted - "boot_always: Boot from the device each time the serveris rebooted"
- connect: Connect the virtual media device and set to boot_always - "connect: Connect the virtual media device and set to boot_always"
- disconnect: Disconnects the virtual media device and set to no_boot - "disconnect: Disconnects the virtual media device and set to no_boot"
required: true required: true
default: boot_once default: boot_once
choices: [ "boot_always", "boot_once", "connect", "disconnect", "no_boot" ] choices: [ "boot_always", "boot_once", "connect", "disconnect", "no_boot" ]