ansible.builtin.add_host (v2.4.0.0-1) — module

add a host (and alternatively a group) to the ansible-playbook in-memory inventory

| "added in version" 0.9 of ansible.builtin"

Authors: Ansible Core Team, Seth Vidal

stableinterface | supported by core

Install Ansible via pip

Install with pip install ansible==2.4.0.0.post1

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.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# add host to group 'just_created' with variable foo=42
- add_host:
    name: "{{ ip_from_ec2 }}"
    groups: just_created
    foo: 42
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# add a host with a non-standard port local to your machines
- add_host:
    name: "{{ new_ip }}:{{ new_port }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# add a host alias that we reach through a tunnel (Ansible <= 1.9)
- add_host:
    hostname: "{{ new_ip }}"
    ansible_ssh_host: "{{ inventory_hostname }}"
    ansible_ssh_port: "{{ new_port }}"
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
# add a host alias that we reach through a tunnel (Ansible >= 2.0)
- add_host:
    hostname: "{{ new_ip }}"
    ansible_host: "{{ inventory_hostname }}"
    ansible_port: "{{ new_port }}"

Inputs

    
name:
    aliases:
    - hostname
    - host
    description:
    - The hostname/ip of the host to add to the inventory, can include a colon and a port
      number.
    required: true

groups:
    aliases:
    - groupname
    - group
    description:
    - The groups to add the hostname to, comma separated.
    required: false