salt.modules.hosts

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »

# salt.modules.hosts

Manage the information in the hosts file

`salt.modules.hosts.` `add_host`(ip, alias)

  Add a host to an existing entry, if the entry is not in place then create it with the given host

  CLI Example:

      salt '*' hosts.add_host <ip> <alias>

`salt.modules.hosts.` `get_alias`(ip)

  Return the list of aliases associated with an ip

  CLI Example:

      salt '*' hosts.get_alias <ip addr>

`salt.modules.hosts.` `get_ip`(host)

  Return the ip associated with the named host

  CLI Example:

      salt '*' hosts.get_ip <hostname>

`salt.modules.hosts.` `has_pair`(ip, alias)

  Return true if the alias is set

  CLI Example:

      salt '*' hosts.has_pair <ip> <alias>

`salt.modules.hosts.` `list_hosts`()

  Return the hosts found in the hosts file in this format:

      {'<ip addr>': ['alias1', 'alias2', ...]}

  CLI Example:

      salt '*' hosts.list_hosts

`salt.modules.hosts.` `rm_host`(ip, alias)

  Remove a host entry from the hosts file

  CLI Example:

      salt '*' hosts.rm_host <ip> <alias>

`salt.modules.hosts.` `set_host`(ip, alias)

  Set the host entry in the hosts file for the given ip, this will overwrite any previous entry for the given ip

  CLI Example:

      salt '*' hosts.set_host <ip> <alias>

## Comments

comments powered by Disqus

### Navigation

- index
- modules |
- next |
- previous |
- « SaltStack.org |
- Documentation home
- Full list of builtin execution modules »