Merge pull request #2559 from mavimo/feature/documentation-vagrant

vagrant module documentation
pull/2565/merge
Michael DeHaan 12 years ago
commit 0440c48fe0

@ -19,7 +19,7 @@ DOCUMENTATION = '''
module: vagrant module: vagrant
short_description: create a local instance via vagrant short_description: create a local instance via vagrant
description: 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" version_added: "1.1"
options: options:
state: state:
@ -27,10 +27,11 @@ options:
- Should the VMs be "present" or "absent." - Should the VMs be "present" or "absent."
cmd: cmd:
description: description:
- vagrant subcommand to execute. Can be "up," "status," "config," "ssh," "halt," "destroy" or "clear." - vagrant subcommand to execute.
required: false required: false
default: null default: null
aliases: ['command'] aliases: ['command']
choices: [ "up", "status", "config", "ssh", "halt", "destroy", "clear" ]
box_name: box_name:
description: description:
- vagrant boxed image to start - vagrant boxed image to start
@ -62,13 +63,13 @@ options:
aliases: [] aliases: []
memory: memory:
description: description:
- memory in MB - memory in MB
required: False required: False
examples: examples:
- code: 'local_action: vagrant cmd=up box_name=lucid32 vm_name=webserver' - code: 'local_action: vagrant cmd=up box_name=lucid32 vm_name=webserver'
description: description:
requirements: [ "vagrant" ] requirements: [ "vagrant", "python-vagrant" ]
author: Rob Parrott author: Rob Parrott
''' '''

Loading…
Cancel
Save