mirror of https://github.com/ansible/ansible.git
utilities: Clean up parameter types and add seealso (#53063)
* utilities: Clean up parameter types and add seealso * Add inventory modules * Add more references, clarify with-loopspull/53449/head
Dag Wieers
5 years ago
committed by
GitHub
parent
77a03af394
commit
f47191674e
@ -1,81 +1,83 @@
|
||||
# -*- mode: python -*-
|
||||
#
|
||||
|
||||
# Copyright: (c) 2012, Seth Vidal (@skvidal)
|
||||
# Copyright: Ansible Team
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['stableinterface'],
|
||||
'supported_by': 'core'}
|
||||
|
||||
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: add_host
|
||||
short_description: add a host (and alternatively a group) to the ansible-playbook in-memory inventory
|
||||
short_description: Add a host (and alternatively a group) to the ansible-playbook in-memory inventory
|
||||
description:
|
||||
- Use variables to create new hosts and groups in inventory for use in later plays of the same playbook.
|
||||
Takes variables so you can define the new hosts more fully.
|
||||
- This module is also supported for Windows targets.
|
||||
- Use variables to create new hosts and groups in inventory for use in later plays of the same playbook.
|
||||
- Takes variables so you can define the new hosts more fully.
|
||||
- This module is also supported for Windows targets.
|
||||
version_added: "0.9"
|
||||
options:
|
||||
name:
|
||||
aliases: [ 'hostname', 'host' ]
|
||||
description:
|
||||
- The hostname/ip of the host to add to the inventory, can include a colon and a port number.
|
||||
type: str
|
||||
required: true
|
||||
aliases: [ host, hostname ]
|
||||
groups:
|
||||
aliases: [ 'groupname', 'group' ]
|
||||
description:
|
||||
- The groups to add the hostname to, comma separated.
|
||||
required: false
|
||||
- The groups to add the hostname to.
|
||||
type: list
|
||||
aliases: [ group, groupname ]
|
||||
notes:
|
||||
- This module bypasses the play host loop and only runs once for all the hosts in the play, if you need it
|
||||
to iterate use a with\_ directive.
|
||||
- Windows targets are supported by this module.
|
||||
- The alias 'host' of the parameter 'name' is only available on >=2.4
|
||||
- Since Ansible version 2.4, the ``inventory_dir`` variable is now set to ``None`` instead of the 'global inventory source',
|
||||
because you can now have multiple sources. An example was added that shows how to partially restore the previous behaviour.
|
||||
- This module bypasses the play host loop and only runs once for all the hosts in the play, if you need it
|
||||
to iterate use a with-loop construct.
|
||||
- The alias C(host) of the parameter C(name) is only available on Ansible 2.4 and newer.
|
||||
- Since Ansible 2.4, the C(inventory_dir) variable is now set to C(None) instead of the 'global inventory source',
|
||||
because you can now have multiple sources. An example was added that shows how to partially restore the previous behaviour.
|
||||
- Windows targets are supported by this module.
|
||||
seealso:
|
||||
- module: group_by
|
||||
author:
|
||||
- "Ansible Core Team"
|
||||
- "Seth Vidal (@skvidal)"
|
||||
- Ansible Core Team
|
||||
- Seth Vidal (@skvidal)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
- name: add host to group 'just_created' with variable foo=42
|
||||
EXAMPLES = r'''
|
||||
- name: Add host to group 'just_created' with variable foo=42
|
||||
add_host:
|
||||
name: "{{ ip_from_ec2 }}"
|
||||
name: '{{ ip_from_ec2 }}'
|
||||
groups: just_created
|
||||
foo: 42
|
||||
|
||||
- name: add host to multiple groups
|
||||
- name: Add host to multiple groups
|
||||
add_host:
|
||||
hostname: "{{ new_ip }}"
|
||||
hostname: '{{ new_ip }}'
|
||||
groups:
|
||||
- group1
|
||||
- group2
|
||||
- group1
|
||||
- group2
|
||||
|
||||
- name: add a host with a non-standard port local to your machines
|
||||
- name: Add a host with a non-standard port local to your machines
|
||||
add_host:
|
||||
name: "{{ new_ip }}:{{ new_port }}"
|
||||
name: '{{ new_ip }}:{{ new_port }}'
|
||||
|
||||
- name: add a host alias that we reach through a tunnel (Ansible <= 1.9)
|
||||
- name: Add a host alias that we reach through a tunnel (Ansible 1.9 and older)
|
||||
add_host:
|
||||
hostname: "{{ new_ip }}"
|
||||
ansible_ssh_host: "{{ inventory_hostname }}"
|
||||
ansible_ssh_port: "{{ new_port }}"
|
||||
hostname: '{{ new_ip }}'
|
||||
ansible_ssh_host: '{{ inventory_hostname }}'
|
||||
ansible_ssh_port: '{{ new_port }}'
|
||||
|
||||
- name: add a host alias that we reach through a tunnel (Ansible >= 2.0)
|
||||
- name: Add a host alias that we reach through a tunnel (Ansible 2.0 and newer)
|
||||
add_host:
|
||||
hostname: "{{ new_ip }}"
|
||||
ansible_host: "{{ inventory_hostname }}"
|
||||
ansible_port: "{{ new_port }}"
|
||||
hostname: '{{ new_ip }}'
|
||||
ansible_host: '{{ inventory_hostname }}'
|
||||
ansible_port: '{{ new_port }}'
|
||||
|
||||
- name: Ensure inventory vars are set to the same value as the inventory_hostname has (close to pre 2.4 behaviour)
|
||||
- name: Ensure inventory vars are set to the same value as the inventory_hostname has (close to pre Ansible 2.4 behaviour)
|
||||
add_host:
|
||||
hostname: charlie
|
||||
inventory_dir: "{{inventory_dir}}"
|
||||
inventory_dir: '{{ inventory_dir }}'
|
||||
'''
|
||||
|
||||
@ -1,43 +1,45 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright 2012 Dag Wieers <dag@wieers.com>
|
||||
# Copyright: (c) 2012, Dag Wieers <dag@wieers.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
from __future__ import absolute_import, division, print_function
|
||||
__metaclass__ = type
|
||||
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['stableinterface'],
|
||||
'supported_by': 'core'}
|
||||
|
||||
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
---
|
||||
module: fail
|
||||
short_description: Fail with custom message
|
||||
description:
|
||||
- This module fails the progress with a custom message. It can be
|
||||
useful for bailing out when a certain condition is met using C(when).
|
||||
- This module is also supported for Windows targets.
|
||||
- This module fails the progress with a custom message.
|
||||
- It can be useful for bailing out when a certain condition is met using C(when).
|
||||
- This module is also supported for Windows targets.
|
||||
version_added: "0.8"
|
||||
options:
|
||||
msg:
|
||||
description:
|
||||
- The customized message used for failing execution. If omitted,
|
||||
fail will simply bail out with a generic message.
|
||||
required: false
|
||||
default: "'Failed as requested from task'"
|
||||
- The customized message used for failing execution.
|
||||
- If omitted, fail will simply bail out with a generic message.
|
||||
type: str
|
||||
default: Failed as requested from task
|
||||
notes:
|
||||
- This module is also supported for Windows targets.
|
||||
|
||||
author: "Dag Wieers (@dagwieers)"
|
||||
seealso:
|
||||
- module: assert
|
||||
- module: debug
|
||||
- module: meta
|
||||
author:
|
||||
- Dag Wieers (@dagwieers)
|
||||
'''
|
||||
|
||||
EXAMPLES = '''
|
||||
EXAMPLES = r'''
|
||||
# Example playbook using fail and when together
|
||||
- fail:
|
||||
msg: "The system may not be provisioned according to the CMDB status."
|
||||
msg: The system may not be provisioned according to the CMDB status.
|
||||
when: cmdb_status != "to-be-staged"
|
||||
'''
|
||||
|
||||
Loading…
Reference in New Issue