Skip to content

host.md

Latest commit

 

History

History
167 lines (129 loc) · 3.52 KB

host.md

File metadata and controls

167 lines (129 loc) · 3.52 KB

Host Module

The host module provides commands to manage SSH host entries in your ~/.ssh/config file. Each command is described below.

Create a Host

This command allows you to create a new host entry in your SSH config.

Usage

cosmos host create --host <host> --hostname <hostname> --user <username> [--port <port>] [--identity-file <path>]

Options

  • --host, -h: Host alias (required)
  • --hostname, -hn: Hostname (IP or domain) (required)
  • --user, -u: Username (required)
  • --port, -p: Port (default: 22)
  • --identity-file, -i: Path to private key (default: ~/.ssh/id_rsa)

Behavior: If any required flag is missing, you will be prompted to provide it interactively.

Example

Create a host entry for myserver:

cosmos host create --host myserver --hostname 192.168.1.10 --user ubuntu

List Hosts

This command lists all hosts in your SSH config.

Usage

cosmos host list

Output

Displays a table with the following columns:

  • Host
  • Hostname
  • User
  • Port
  • IdentityFile

Example

List all hosts:

cosmos host list

Show Host

This command shows details of a specific host in your SSH config.

Usage

cosmos host show <host>

Arguments

  • <host>: The host alias to show details for.

Output

Displays all details for the specified host.

Example

Show details for myserver:

cosmos host show myserver

Remove Host

This command removes a host entry from your SSH config.

Usage

cosmos host remove <host>

Arguments

  • <name>: Host alias to remove.

Behavior: If the alias is not provided, you will be prompted to enter it.

Example

Remove the host entry for myserver:

cosmos host remove myserver

Update Host

This command updates an existing host entry in your SSH config.

Usage

cosmos host update <host> [--user <username>] [--port <port>] [--host <alias>] [--hostname <hostname>] [--identity-file <path>]

Arguments

  • <name>: Host alias to update.

Options

  • --host, -h: Host alias
  • --hostname, -h: Hostname (IP or domain)
  • --user, -u: Username
  • --port, -p: Port
  • --identity-file, -i: Path to private key

Behavior: If the alias is not provided, you will be prompted to enter it. Only the provided fields will be updated.

Example

Update the user and port for myserver:

cosmos host update myserver --user admin --port 2222

Set Host Metadata

This command allows you to set a metadata key-value pair for a specified host.

It is used maily by other modules to register capabilities or features of the host, such as Docker support.

Usage

cosmos host set <host> <key> <value>

Arguments

  • <host>: The hostname, IP, or alias of the target host.
  • <key>: The metadata key to set.
  • <value>: The value to set for the key. You can prefix the value with bool: or number: to cast the value (e.g., bool:true, number:42).

Examples

Set a string metadata value:

cosmos host set myserver location "datacenter-1"

Set a boolean metadata value:

cosmos host set myserver enabled bool:true

Set a numeric metadata value:

cosmos host set myserver max_connections number:100

Unset Host Metadata

This command allows you to remove a metadata key from a specified host.

Usage

cosmos host unset <host> <key>

Arguments

  • <host>: The hostname, IP, or alias of the target host.
  • <key>: The metadata key to remove.

Examples

Remove a metadata key:

cosmos host unset myserver location