Merge pull request #2559 from mavimo/feature/documentation-vagrant
vagrant module documentation
This commit is contained in:
commit
087859a0d0
1 changed files with 8 additions and 7 deletions
15
vagrant
15
vagrant
|
@ -19,7 +19,7 @@ DOCUMENTATION = '''
|
|||
module: vagrant
|
||||
short_description: create a local instance via vagrant
|
||||
description:
|
||||
- creates VM instances via vagrant and optionally waits for it to be 'running'. This module has a dependency on python-vagrant.
|
||||
- creates VM instances via vagrant and optionally waits for it to be 'running'.
|
||||
version_added: "1.1"
|
||||
options:
|
||||
state:
|
||||
|
@ -27,10 +27,11 @@ options:
|
|||
- Should the VMs be "present" or "absent."
|
||||
cmd:
|
||||
description:
|
||||
- vagrant subcommand to execute. Can be "up," "status," "config," "ssh," "halt," "destroy" or "clear."
|
||||
- vagrant subcommand to execute.
|
||||
required: false
|
||||
default: null
|
||||
aliases: ['command']
|
||||
aliases: ['command']
|
||||
choices: [ "up", "status", "config", "ssh", "halt", "destroy", "clear" ]
|
||||
box_name:
|
||||
description:
|
||||
- vagrant boxed image to start
|
||||
|
@ -62,13 +63,13 @@ options:
|
|||
aliases: []
|
||||
memory:
|
||||
description:
|
||||
- memory in MB
|
||||
- memory in MB
|
||||
required: False
|
||||
|
||||
|
||||
examples:
|
||||
- code: 'local_action: vagrant cmd=up box_name=lucid32 vm_name=webserver'
|
||||
description:
|
||||
requirements: [ "vagrant" ]
|
||||
description:
|
||||
requirements: [ "vagrant", "python-vagrant" ]
|
||||
author: Rob Parrott
|
||||
'''
|
||||
|
||||
|
|
Loading…
Reference in a new issue