Provide a list of host group overriding values, to modify an existing inventory.

Typically used to patch an Ansible inventory (see ansible_inventory_files) with some new values


Each item of the list has the following attributes:

Name req? Description
name yes The name of the host to patch. Must be an existing host. Also may be 'all' or '*' to patch all hosts.
hosts no Allow to override the original hosts list
force_setup no A common Ansible problem is when referencing host info for a host which has not being accessed, so there is no fact grabbed for it.
Setting this flag to yes will trigger an access to all hosts of this group at the begining of the play.
when no Boolean. Allow conditional deployment of this item.
Default True


A common pitfall is the infamous AnsibleUndefinedVariable: 'dict object' has no attribute 'ansible_fqdn' message. This is due to the fact we are referencing some variables (ansible_fqdn) of hosts which are not part of the playbook.

The following example force all hosts of the zookeepers group to be included at the top of the playbook

- name: zookeepers
  force_setup: yes


If, when running HADeploy you encounter error like:

fatal: [dn1]: FAILED! => {"changed": false, "failed": true, "msg": "AnsibleUndefinedVariable: 'dict object' has no attribute 'ansible_fqdn'"}

it is most likely that you need to set force_setup on some host_group or host.