BuildMaster Documentation

Network - Ensure Hosts Entry

  • Last Modified: 2020-06-26

This is generated from the built-in components of BuildMaster 6.2.13, and may be different than what you have installed (especially if you have extensions); go to [User Icon] > Documentation within your BuildMaster instance to see exactly what operations are available.

Ensure Hosts Entry

Ensures an entry in the hosts file on a server.

Script usage:

Ensure-HostsEntry(
	Host: <text>,
	IP: <text>,
	[Exists: <true/false>]
);

This operation may be prefixed with Network::, although this is a built-in namespace and isn't really necessary.

Arguments:

Name Format Script Usage Usage Notes
Host name
text
Host
This argument is required.
IP address
text
IP
This argument is required.
Exists
true/false
Exists

Example:

# bind otter.localhost to local ip
Ensure-HostsEntry otter.localhost (IP: 127.0.0.1);

# override hdars.com to a local address
Ensure-HostsEntry (
  Host: hdars.com
  IP: 192.168.10.0);

Is this documentation incorrect or incomplete? Help us by contributing!

This documentation is licensed under CC-BY-SA-4.0 and stored in GitHub.

Generated from commit ced119d5 on master