Otter Documentation

network - Ensure Hosts Entry

  • Last Modified: 2018-11-09

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

Ensure Hosts Entry

Ensures an entry in the hosts file on a server.

Operation type:

Ensuring - this operation will ensure a specified configuration exists on a remote server after comparing its current state to the desired state.

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 the unique key for this operation, which means it must uniquely identify the target of the operation. 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);

Have a question? Try the Q&A Forum

Our documentation is now Open Source and on GitHub. We highly encourage our users to contribute and get involved! .