mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-28 13:21:25 -07:00
updated vbox docs
This commit is contained in:
parent
21da284f5d
commit
68936d0530
1 changed files with 11 additions and 2 deletions
|
@ -27,20 +27,29 @@ DOCUMENTATION:
|
||||||
options:
|
options:
|
||||||
running_only:
|
running_only:
|
||||||
description: toggles showing all vms vs only those currently running
|
description: toggles showing all vms vs only those currently running
|
||||||
|
type: boolean
|
||||||
default: False
|
default: False
|
||||||
settings_password_file:
|
settings_password_file:
|
||||||
description: provide a file containing the settings password (equivalent to --settingspwfile)
|
description: provide a file containing the settings password (equivalent to --settingspwfile)
|
||||||
network_info_path:
|
network_info_path:
|
||||||
description: property path to query for network information (ansible_host)
|
description: property path to query for network information (ansible_host)
|
||||||
default: "/VirtualBox/GuestInfo/Net/0/V4/IP"
|
default: "/VirtualBox/GuestInfo/Net/0/V4/IP"
|
||||||
|
query:
|
||||||
|
description: create vars from virtualbox properties
|
||||||
|
type: dictionary
|
||||||
|
default: {}
|
||||||
|
compose:
|
||||||
|
description: create vars from jinja2 expressions, these are created AFTER the query block
|
||||||
|
type: dictionary
|
||||||
|
default: {}
|
||||||
EXAMPLES:
|
EXAMPLES:
|
||||||
# file must be named vbox.yaml or vbox.yml
|
# file must be named vbox.yaml or vbox.yml
|
||||||
simple_config_file:
|
simple_config_file:
|
||||||
plugin: virtualbox
|
plugin: virtualbox
|
||||||
settings_password_file: /etc/virtulbox/secrets
|
settings_password_file: /etc/virtulbox/secrets
|
||||||
query: # create vars from virtualbox properties
|
query:
|
||||||
logged_in_users: /VirtualBox/GuestInfo/OS/LoggedInUsersList
|
logged_in_users: /VirtualBox/GuestInfo/OS/LoggedInUsersList
|
||||||
compose: # compose vars from jinja2 expressions
|
compose:
|
||||||
ansible_connection: ('indows' in vbox_Guest_OS)|ternary('winrm', 'ssh')
|
ansible_connection: ('indows' in vbox_Guest_OS)|ternary('winrm', 'ssh')
|
||||||
'''
|
'''
|
||||||
from __future__ import (absolute_import, division, print_function)
|
from __future__ import (absolute_import, division, print_function)
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue