Files
community.general/docs/json/virt.json
2012-10-10 18:41:50 -04:00

58 lines
1.6 KiB
JSON

{
"requirements": [
"libvirt"
],
"description": [
"Manages virtual machines supported by I(libvirt)."
],
"author": "Michael DeHaan, Seth Vidal",
"notes": [
"Other non-idempotent commands are: C(status), C(pause), C(unpause), C(get_xml), C(autostart), C(freemem), C(list_vms), C(info), C(nodeinfo), C(virttype)"
],
"docuri": "virt",
"module": "virt",
"filename": "library/virt",
"examples": [
{
"code": "virt guest=alpha state=running",
"description": "Example from Ansible Playbooks"
},
{
"code": "ansible host -m virt -a \"guest=alpha command=status\"",
"description": "Example guest management with C(/usr/bin/ansible)"
}
],
"version_added": "0.2",
"short_description": "Manages virtual machines supported by libvirt",
"now_date": "2012-10-09",
"options": {
"state": {
"default": "no",
"required": false,
"description": [
"Note that there may be some lag for state requests like C(shutdown) since these refer only to VM states. After starting a guest, it may not be immediately accessible."
],
"choices": [
"running",
"shutdown",
"destroyed",
"undefined"
]
},
"command": {
"required": false,
"description": [
"in addition to state management, various non-idempotent commands are available. See examples"
]
},
"name": {
"default": null,
"required": true,
"description": [
"name of the guest VM being managed"
],
"aliases": []
}
},
"ansible_version": "0.8"
}