DSCResources/DSC_HostsFile/en-US/about_HostsFile.help.txt
|
.NAME
HostsFile .DESCRIPTION This resource is used to control entries on a the host file for a node. .PARAMETER HostName Key - String Specifies the name of the computer that will be mapped to an IP address. .PARAMETER IPAddress Write - String Specifies the IP Address that should be mapped to the host name. .PARAMETER Ensure Write - String Allowed values: Present, Absent Specifies if the hosts file entry should be created or deleted. .EXAMPLE 1 Add a new host to the host file. Configuration HostsFile_AddEntry_Config { Import-DSCResource -ModuleName NetworkingDsc Node localhost { HostsFile HostsFileAddEntry { HostName = 'Host01' IPAddress = '192.168.0.1' Ensure = 'Present' } } } .EXAMPLE 2 Remove a host from the hosts file. Configuration HostsFile_RemoveEntry_Config { Import-DSCResource -ModuleName NetworkingDsc Node localhost { HostsFile HostsFileRemoveEntry { HostName = 'Host01' IPAddress = '192.168.0.1' Ensure = 'Absent' } } } |