community.windows.win_hosts module – Manages hosts file entries on Windows.
This module is part of the community.windows collection (version 1.12.0).
You might already have this collection installed if you are using the
It is not included in
To check whether it is installed, run
ansible-galaxy collection list.
To install it, use:
ansible-galaxy collection install community.windows.
To use it in a playbook, specify:
Manages hosts file entries on Windows.
Maps IPv4 or IPv6 addresses to canonical names.
Adds, removes, or sets cname records for ip and hostname pairs.
Controls the behavior of aliases.
Only applicable when
A list of additional names (cname records) for the host entry.
Only applicable when
A canonical name for the host entry.
The ip address for the host entry.
Can be either IPv4 (A record) or IPv6 (AAAA record).
Whether the entry should be present or absent.
If only canonical_name is provided when
If only ip_address is provided when
If ip_address and canonical_name are both omitted when
Each canonical name can only be mapped to one IPv4 and one IPv6 address. If canonical_name is provided with
state=presentand is found to be mapped to another IP address that is the same type as, but unique from ip_address, then canonical_name and all aliases will be removed from the entry and added to an entry with the provided IP address.
Each alias can only be mapped to one canonical name. If aliases is provided with
state=presentand an alias is found to be mapped to another canonical name, then the alias will be removed from the entry and either added to or removed from (depending on action) an entry with the provided canonical name.
Template a file out to a remote server.
Creates, touches or removes files or directories.
Copies files to remote locations on windows hosts.
- name: Add 127.0.0.1 as an A record for localhost community.windows.win_hosts: state: present canonical_name: localhost ip_address: 127.0.0.1 - name: Add ::1 as an AAAA record for localhost community.windows.win_hosts: state: present canonical_name: localhost ip_address: '::1' - name: Remove 'bar' and 'zed' from the list of aliases for foo (192.168.1.100) community.windows.win_hosts: state: present canonical_name: foo ip_address: 192.168.1.100 action: remove aliases: - bar - zed - name: Remove hosts entries with canonical name 'bar' community.windows.win_hosts: state: absent canonical_name: bar - name: Remove 10.2.0.1 from the list of hosts community.windows.win_hosts: state: absent ip_address: 10.2.0.1 - name: Ensure all name resolution is handled by DNS community.windows.win_hosts: state: absent