community / community.general / 1.3.14 / inventory / docker_machine Docker Machine inventory source Authors: Ximon Eighteen (@ximon18)community.general.docker_machine (1.3.14) — inventory
Install with ansible-galaxy collection install community.general:==1.3.14
collections: - name: community.general version: 1.3.14
Get inventory hosts from Docker Machine.
Uses a YAML configuration file that ends with docker_machine.(yml|yaml).
The plugin sets standard host variables C(ansible_host), C(ansible_port), C(ansible_user) and C(ansible_ssh_private_key).
The plugin stores the Docker Machine 'env' output variables in I(dm_) prefixed host variables.
groups: default: {} description: Add hosts to group based on Jinja2 conditionals. type: dict plugin: choices: - docker_machine - community.general.docker_machine description: token that ensures this is a source file for the C(docker_machine) plugin. required: true strict: default: false description: - If V(yes) make invalid entries a fatal error, otherwise skip and continue. - Since it is possible to use facts in the expressions they might not always be available and we ignore those errors by default. type: bool compose: default: {} description: Create vars from jinja2 expressions. type: dict daemon_env: choices: - require - require-silently - optional - optional-silently - skip default: require description: - Whether docker daemon connection environment variables should be fetched, and how to behave if they cannot be fetched. - With C(require) and C(require-silently), fetch them and skip any host for which they cannot be fetched. A warning will be issued for any skipped host if the choice is C(require). - With C(optional) and C(optional-silently), fetch them and not skip hosts for which they cannot be fetched. A warning will be issued for hosts where they cannot be fetched if the choice is C(optional). - With C(skip), do not attempt to fetch the docker daemon connection environment variables. - If fetched successfully, the variables will be prefixed with I(dm_) and stored as host variables. type: str keyed_groups: default: [] description: Add hosts to group based on the values of a variable. elements: dict suboptions: default_value: description: - The default value when the host variable's value is an empty string. - This option is mutually exclusive with O(keyed_groups[].trailing_separator). type: str version_added: '2.12' version_added_collection: ansible.builtin key: description: - The key from input dictionary used to generate groups type: str parent_group: description: parent group for keyed group type: str prefix: default: '' description: A keyed group name will start with this prefix type: str separator: default: _ description: separator used to build the keyed group name type: str trailing_separator: default: true description: - Set this option to V(False) to omit the O(keyed_groups[].separator) after the host variable when the value is an empty string. - This option is mutually exclusive with O(keyed_groups[].default_value). type: bool version_added: '2.12' version_added_collection: ansible.builtin type: list use_extra_vars: default: false description: Merge extra vars into the available variables for composition (highest precedence). env: - name: ANSIBLE_INVENTORY_USE_EXTRA_VARS ini: - key: use_extra_vars section: inventory_plugins type: bool version_added: '2.11' version_added_collection: ansible.builtin verbose_output: default: true description: when true, include all available nodes metadata (e.g. Image, Region, Size) as a JSON object named C(docker_machine_node_attributes). type: bool running_required: default: true description: when true, hosts which Docker Machine indicates are in a state other than C(running) will be skipped. type: bool leading_separator: default: true description: - Use in conjunction with keyed_groups. - By default, a keyed group that does not have a prefix or a separator provided will have a name that starts with an underscore. - This is because the default prefix is "" and the default separator is "_". - Set this option to False to omit the leading underscore (or other separator) if no prefix is given. - If the group name is derived from a mapping the separator is still used to concatenate the items. - To not use a separator in the group name at all, set the separator for the keyed group to an empty string instead. type: boolean version_added: '2.11' version_added_collection: ansible.builtin