List of Host Actions

The following table lists actions available in the Hosts→Hosts page. It lists the name of the action, its corresponding command-line client command, and a brief description of what the action does.

Table 7.1. Host-Managing Actions

Action	Command-line client command	Description
Add to Group	add-hosts-to-group	Adds target host(s) to a host group.
Backend Tag	add-hosts	Mark or unmark the selected host(s) as a member of a back-end group. Jobs for this host are handled by the back end with the same tag. For more information about managing hosts with specific back ends, see Managing Hosts with Specific Back Ends.
Delete	delete-host	Delete the target host(s), along with all information about related objects, such as keys stored on the host(s). There is no way to undo this action. For more detailed information about deleting hosts, see Deleting Hosts.
Deploy	deploy-hosts	Switches the state of the selected host from Available to Monitored. This action adds the host to the managed environment (detailed process description is in Host-Deployment Process.)
Edit Custom Fields	modify-host	The custom fields Custom 1, Custom 2, and Custom 3 can be used to associate single-line, free-text information to target host(s). Similarly to tags, the hosts can be filtered according to the values in the custom fields. For more information about configuring custom data and other host attributes, see Configuring Host Attributes.
Edit Description	modify-host	This action can be performed to only one host at a time. For more information about editing the host description and other host attributes, see Configuring Host Attributes.
Edit Host Classification	modify-host	Add, change, or remove classifications to selected host(s). These can be used to filter and search for specific host(s). Available classifications can be modified in the Settings → Global. Each host can only have one classification at a time. For more information about editing host classifications and other host attributes, see Configuring Host Attributes.
Edit Hostname	modify-host	Edit a selected host's hostname. When a host is added to the managed environment, Key Manager by default names each host according to its FQDN. If the FQDN cannot be resolved, then the host is named according to its IP address. Key Manager administrators can later change the host name. Note: After you have changed the host name of a host, the hostname value of all the users and user keys on that host are updated as well: filters that use the old hostname value no longer work. Remember to use the new hostname when filtering for users and user keys on renamed hosts.
Key Activity Scan	scan-host-key-activity	Scan target host(s) for login data. For more information about key activity scan, see Obtaining Key-Activity Data.
Manage	manage-hosts	Switches the state of the target host(s) from monitored to managed. This enables key-management operations on the host. Before the state of a host can be switched from monitored to managed, the host must have been scanned succesfully at least once.
Monitor	—	Switches the state of the target host(s) from suspended to monitored. Scans are enabled on the host.
Move in Hierarchy	—	Remove the target host(s) from a host group, and add them to an ancestor or descendant group.
Redeploy	redeploy-hosts	Host redeployment allows you to re-specify and regenerate the credentials used for establishing management connections, without removing any management data associated to the host. For more detailed information about redeploying hosts, see Redeploying Hosts.
Relocate User Keys	relocate-user-keys	Relocate user keys included in the selected host(s) to another location. For more information, see Relocating User Keys.
Remove From Group	remove-hosts-from-group	Remove the target host(s) from a host group.
Renew Management Key	renew-management-keys	On target agentless hosts, renew the key that Key Manager uses for management connections. For more information about renewing management keys, see Renewing Management Keys.
Scan	scan-hosts-configs / scan-hosts-authorized-keys / scan-hosts	Perform a scan on the target host(s). This action allows you to perform: Configuration Scan: reads and detects changes in SSH configurations, installed SSH products, SSH host keys and basic system information. Authorized Key Scan: covers the same information as configuration scan, and additionally scans target hosts for authorized keys. Full Scan: scans target host(s) for the same information as configuration and authorized-key scan, and additionally scans for private keys. For more information about scans, see Discovery and Monitoring.
Settings	set-host-setting	Edit the target-host settings. For more information about configuring host settings, see Configuring Host and Host-Credential Settings.
Suspend	suspend-hosts	Switches the state of the target host(s) from managed or monitored to suspended. This prevents Key Manager from establishing management connections to the host. Switching a host to the suspended state also disables all management actions that require access to the host.
Tag	tag-hosts untag-hosts	Add or remove tags to help sorting and filtering hosts.
Unmanage	unmanage-hosts	Switches the state of the target host(s) from managed to monitored. This disables key-management operations on the host.
View Audit History	—	View audit-event logs related to the selected host. For more information about audit events, see Auditing, Alerting, and Reporting.