Host Commands
Host commands are used for performing host management. For information about host management tasks, see Managing the Hosts in the Managed Environment.
add-hosts
Syntax:
ssh-mgr-client add-hosts [options] \
(-d <data> | -f <file>) [-vvv] [-U <url>] [ -o <format>] [-B] \
[-T <timeout>] [-t <tags>] [-b <backend-tags>] [-p <priority>]
Adds hosts using agentless connections.
The hosts that are to be added must be identified using their host name (IP or FQDN format). Additionally, you must provide credentials for a sufficiently privileged account (such as root) on each host. The account is used for running management operations on the host.
For more information about sufficiently privileged accounts, see Host-Deployment Prerequisites.
You must provide the following data for identifying the hosts that are to be added:
hostname
The FQDN or IP address of the host
username
The name of the account that is used to manage the host (management account).
Additionally, you must provide credentials for logging into the management account. You can do this by providing one of the following:
password
Password for logging into the management account
privatekey
Private-key (contents of a private-key file) used for logging into the management account.
privatekeyfile
Path (on the local machine) to the private-key file that can be used for logging into the management account.
If you are running the command-line client as a non-privileged user, the specified private-key file must be readable for that user. If you are running the command-line client as root or other privileged user, the specified private-key file must be readable for the user sshmgr.
You can also provide the following optional data:
port
The SSH port number on the host that is to be added. Defaults to 22.
privatekeypassphrase
Passphrase used to encrypt the private key that is used for logging into the management account.
tomanagedstate
If set to true, all added hosts are automatically brought to the managed state, which enables key-management actions on the hosts. Additionally, all SSH configurations on the added hosts are automatically brought to the managed state. Defaults to false.
By default, newly added hosts are automatically brought to the monitored state.
tomonitoredstate
If set to False, added hosts will not undergo automatic discovery nor automatic scans. Also, such hosts will be left in the available state. Defaults to true.
By default, newly added hosts are automatically brought to the monitored state.
description
Free-text description for the host
hostgroup
The ID or the name of a host group. When specified, added hosts are automatically added to the specified host group.
The command launches a discover jobs for deploying the specified hosts. The authorized keys are deployed as soon as this job finishes.
We recommend specifying the hostgroup using its ID value. hostgroup may be specified using the name of the host group, but only if the name is unique in the Key Manager system.
winrm
Set to true to indicate that the host should be deployed as an agentlessly connected Windows host using WinRM. By default false.
For example, when adding one host at a time, you can specify the arguments directly on the command line:
$ ssh-mgr-client add-hosts -d \
hostname=example.server.com,username=username,password=password
As another example, adding a host using a passphrase-protected private key:
$ ssh-mgr-client add-hosts -d hostname=10.11.0.134,username=username,\
privatekeyfile=/path/to/privatekey,privatekeypassphrase=passphrase
Private keys used for adding hosts must be passphrase protected. Unprotected private keys are not accepted. When using private keys to access the management account, also provide the privatekey passphrase using the privatekeypassphrase option.
When adding multiple hosts with a single command, it may be more convenient to specify the arguments in a file, and load them using the -f option.
Example:
$ ssh-mgr-client add-hosts -f /path/to/add_hosts_week30-2012.csv
The following is an example of what the contents of add_hosts_week30-2012.csv could look like. The example file illustrates the minimum information required for identifying the hosts that are to be added, and the credentials to their management accounts.
hostname,username,password
sap1.example.com,username,password
sap2.example.com,username,password
dbeast.example.com,username,password
192.0.2.100,username,password
logistics.example.com,username,password
192.0.2.124,username,password
As another example, the following example file illustrates adding hosts, while using private keys for initial authorization to the management account.
hostname,username,privatekeyfile,privatekeypassphrase
sap1.example.com,username,/opt/private/username/private_key,passphrase
sap2.example.com,username,/home/username/.ssh/private_key,passphrase
dbeast.example.com,username,/home/username/.ssh2/private_key,passphrase
192.0.2.100,username,/opt/private/username/private_key,passphrase
logistics.example.com,username,/opt/private/username/private_key,passphrase
192.0.2.124,username,/opt/private/username/private_key,passphrase
Hosts can be associated with back-end tags and regular tags as they are added, using the options -b and
-t respectively:
$ ssh-mgr-client add-hosts -f /path/to/add_hosts_week30-2012.csv \
-b backend_tag -t host_tag1,host_tag2
You can get a log of the jobs generated by the command:
$ ssh-mgr-client add-hosts -f /path/to/add_hosts_week30-2012.csv \
--log-directory /example/log/directory
If any jobs are logged as failed, such jobs can be rerun by providing the log file as input data:
$ ssh-mgr-client add-hosts -f /example/log/directory/report_xxxxx.dat
count-hosts
Syntax:
ssh-mgr-client count-hosts [options] [-F <filter>] [-vvv] [-U <url>]
Returns the number of hosts in the Key Manager system.
When filters are specified, this command returns the number of hosts that match the filter criteria. For filtering, you can use the same attributes that are available for the list-hosts command (see list-hosts).
Example:
$ ssh-mgr-client count-hosts
362
Example for displaying the number of those hosts, the IP of which starts with 10:
$ ssh-mgr-client count-hosts -F "ip=10*"
194
count-users
Syntax:
ssh-mgr-client count-users [options] [-F <filter>] [-vvv] [-U <url>]
Returns the number of users that match the given criteria. For filtering, you can use the same attributes that are available for the list-users command (see list-users).
Using the command without filters returns the number of users found in the managed environment:
$ ssh-mgr-client count-users
482
Example for displaying the number of users that are on a specific host:
$ ssh-mgr-client count-users -F "hostname=example.server.com"
10
delete-host
Syntax:
ssh-mgr-client delete-host -i <id> [options] [-vvv] [-U <url>] [-B]
Deletes a host from the managed environment.
You can delete a host from the managed environment to disassociate it from the Key Manager system. Data located on the deleted host is not modified in any way during deletion: Keys that were set up on the host function similarly before and after host deletion. The Key Manager host ID file (created during initial host discovery) is also left on the host.
Deleting a host from the managed environment irrevocably removes management data gathered from the host, including information about its users, keys, management history, and authorizations from and to the host.
Key-activity logs are unaffected by host deletion. However, if you add a deleted host back to the managed environment, Key Manager is unable to associate previously gathered key-activity information to the keys on this host.
To run this command, you must identify the host by providing its ID:
$ ssh-mgr-client delete-host -i 2
For more information about deleting hosts, see Deleting Hosts.
deploy-hosts
Syntax:
ssh-mgr-client deploy-hosts [options] \
(-F <filter> | -i <id>) [-vvv] [-U <url>] [-B] [-p <priority>]
Deploys the selected available host(s) to the monitored state. More precisely, this command runs the initial host-discovery and scan jobs on the selected hosts that are in the available state, and brings them to the monitored state.
This command can be used to rerun host deployment for hosts that previously failed to deploy. If you are adding hosts to the managed environment for the first time, use the command add-hosts instead (described in add-hosts).
You can select a host using its ID value. Alternatively, you can also select multiple hosts using filters (-F). For filtering, you can use the same attributes that are available for the list-hosts command (see list-hosts).
The command launches to-monitored-state-host jobs for bringing the selected hosts to monitored state. The hosts are in the monitored state as soon as the jobs finish.
For example, to deploy a host with a specific id:
$ ssh-mgr-client deploy-hosts -i 12
As another example, to deploy all Linux hosts:
$ ssh-mgr-client deploy-hosts -F "os=linux"
edit-hosts
Syntax:
ssh-mgr-client edit-hosts [options] \
(-F <id-filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Set the custom-data fields of the selected hosts.
In input data (-d), specify the fields and their new values in columnname=value format. Any existing values for the specified fields are overwritten using the new values. Select the hosts using their ID (-i), or using matching ID filters (-F). For ID filtering, you can use the same attributes that are available for the list-hosts command (described in list-hosts).
Names of the fields that can be modified with this command:
- classification
- custom1
- custom2
- custom3
- hostname
For example, setting custom1 to Example value, and setting custom2 to value,value2 for all hosts with tag examplegroup1:
$ ssh-mgr-client edit-hosts -d \
"custom1=Example value,custom2=value,value2" -F "tags=examplegroup1"
edit-users
Syntax:
ssh-mgr-client edit-users [options] \
(-F <id-filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Set the custom-data fields of the selected users.
In input data (-d), specify the fields and their new values in columnname=value format. Any existing values for the specified fields are overwritten using the new values. Select the users by their ID (-i), or by using matching ID filters (-F). For ID filtering, you can use the same attributes that are available for the list-users command (described in list-users).
Names of the fields that can be modified with this command:
- custom1
- custom2
- custom3
For example, setting custom1 to Example value, and setting custom2 to value,value2 for users in hostgroup sample1:
$ ssh-mgr-client edit-users -d \
"custom1=Example value,custom2=value,value2" -F "hostgroup=sample1"
list-hosts
Syntax:
ssh-mgr-client list-hosts [options] [-vvv] [-U <url>] \
[-F <filter>] [-o <format>] [ -C <columns>] [-H] [-O <sort-order>] \
[-S <start-from>] [-M <max-results>] [-E <delim>] [-B]
The default command returns all the hosts in the managed environment, outputting their state, status, hostname, ssh_version_string, and id:
$ ssh-mgr-client list-hosts
monitored,ok,192.0.2.100,Linux CentOS release 6.4 (Final),SSH-2.0-OpenSSH_5.3,12
managed,ok,server03.example.com,Microsoft Windows 7 Enterprise Service Pack 1,\
UKM Windows Agent 1.3.2-8640,5
managed,ok,exampleserver,Linux CentOS release 6.4 (Final),\
SSH-2.0-6.3.5.93 SSH Tectia Server,6
...
The following columns can be used for filtering (-F) and output formatting (-C):
alert_count
Number of active alerts for this host. Only usable for output formatting (-C).
applications
List of application instances the host is associated with
architecture
System architecture
backend_tags
Backend tags attached to the host
classification
Classification of the host
custom1
Custom 1 field for the host
custom2
Custom 2 field for the host
custom3
Custom 3 field for the host
date_deployed
Date when host was first deployed
date_modified
Date when a modification that affected host was last made. Only usable for filtering (-F).
description
Free text description of host
first_gapless_key_activity_date
Date of the first recorded key activity entry
first_key_activity_date
Date of the first recorded key activity entry
has_agent
True if host has agent installed
hostgroup
Name of host group that the host is a member of. Only usable for filtering (-F).
hostgroupid
Id of host group that the host is a member of. Only usable for filtering (-F).
hostname
Hostname for the host
id
Internal PrivX Key Manager id for host
ip
IP address(es) of the host
is_control_host
Is control host for accessing network directory users
key_relocation_path
Key relocation path
key_relocation_stage
Key relocation stage
key_relocation_stage_localized
Key relocation stage (localized)
last_auth_keys_scan
Date of the last time when authorized keys were scanned
last_configs_scan
Date of the last time general host information was scanned
last_key_activity_date
Date of the last recorded key activity entry
last_key_activity_scan
Date of the last time host was scannedfor key activity
last_private_keys_scan
Date of the last time when private keys were scanned
last_scan
Date of the last time host was scanned
last_successful_connection
Time the host was last connected successfully
operation_id
Internal PrivX Key Manager id for operation the host is a part of. Only usable for filtering (-F).
os
Operating System
os_kernel
Operating System kernel
os_release
Operating System release
policy_violation_details
Detailed list of policy rules this host is currently violating
policy_violation_score
Combined numeric severities of the policies this host is currently violating
policy_violations
List of policy rules this host is currently violating
ssh_port
Port for the installed SSH server
ssh_version_string
Version string returned by SSH server or key agent
state
Management state of the host
status
Status of host connection, can be ok or failed
tags
Tags attached to the host
time_since_first_gapless_key_activity_date
Time since the first recorded key activity entry
time_since_first_key_activity_date
Time since the first recorded key activity entry
time_since_last_auth_keys_scan
Time since host authorized keys was scanned
time_since_last_configs_scan
Time since host configs was scanned
time_since_last_key_activity_date
Time since last recorded key activity entry
time_since_last_key_activity_scan
Time since host key activity was scanned
time_since_last_scan
Time since host was scanned
unique_id
Unique id for host
user_directories
List of user directories the host is using
For example, to find all the Linux hosts in the managed environment:
$ ssh-mgr-client list-hosts -F "os=linux"
You can specify what columns are shown using -C:
$ ssh-mgr-client list-hosts -C "hostname,state,port"
To filter for hosts by modified date:
$ ssh-mgr-client list-hosts -F "date_modified>=2014-10"
For more information about filtering by modified date, see add-hosts.
list-users
Syntax:
ssh-mgr-client list-users [options] [-F <filter>] [-vvv] [-U <url>] \
[-o <format>] [-C <columns>] [-H] [-O <sort-order>] [-S <start-from>] \
[-M <max-results>] [-E <delim>] [-B]
The default command lists all the users in the managed environment.
Example:
$ ssh-mgr-client list-users
In larger environments with lots of users, it is recommended to filter the list to display only the relevant entries.
The following columns can be used for filtering (-F) and output formatting (-C):
active_authkey_count
How many active authorized keys the user has
active_privatekey_count
How many active private keys the user has
applications
List of application instances the user is associated with
authkey_count
How many authorized keys the user has
custom1
Custom 1 field for the user
custom2
Custom 2 field for the user
custom3
Custom 3 field for the user
date_found
Date when account was first added to management system
description
Description for user account
global_identity
Global identity of the user
global_identity_id
Internal PrivX Key Manager id for the global identity of the user
has_active_requests
User has active requests. Only usable for filtering (-F).
homedir
Home directory
homedir_sharing
Home directory sharing
host_id
Host id for the host where user account resides
host_id_with_directory_users
Host id with directory users. Only usable for filtering (-F).
hostgroup
Name of host group that the user is in. Only usable for filtering (-F).
hostgroupid
Id of host group that the user is in. Only usable for filtering (-F).
hostname
Hostname where user account resides
hostname_with_directory_users
Hostname with directory users. Only usable for filtering (-F).
id
Internal PrivX Key Manager id for user
is_agentless_user
True if user account is used for agentless connections
last_modified
Date when account was last updated by management system
os_gid
OS id of primary group for user account
os_group
OS primary group for user account
os_uid
OS uid of user on host where this account resides
privatekey_count
How many private keys the user has
shell
User's shell
sid
Security identifier for user
state
State of the user id
tags
Tags attached to the user
user_directory_id
Internal PrivX Key Manager id for the directory of the user
user_directory_name
Name of the directory of the user
user_directory_type
Type of the directory of the user
username
Account name
For example, to find all the users on the host named server.example.com:
$ ssh-mgr-client list-users -F "hostname=server.example.com"
To find all the root accounts, and list their ID and number of authorized keys:
$ ssh-mgr-client list-users -F "username=root" -C "id,authkey_count"
manage-hosts
Syntax:
ssh-mgr-client [-v] [-U <url>] manage-hosts (-F <filter> | -i <id>)
Switches the management state of the selected hosts to managed.
Select a target hosts using its host ID. Alternatively, you can use filters to select all matching hosts. For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
For example, to manage a host with a certain ID:
$ ssh-mgr-client manage-hosts -i 8
As another example, to manage all the Linux hosts:
$ ssh-mgr-client manage-hosts -F "os=linux"
modify-host
Syntax:
ssh-mgr-client modify-host [options] \
(-I <id-filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Set the custom-data fields of the selected host.
In input data (-d), specify the fields and their new values in columnname=value format. Any existing values for the specified fields are overwritten using the new values.
Select the host using its ID (-i), or using matching ID filters (-I). For ID filtering, you can use the same attributes that are available for the list-hosts command (described in list-hosts).
When using ID filtering, make sure that the filter will only list one host - trying to modify multiple hosts with this command will fail with an error. For a similar command that can target multiple hosts at once, see edit-hosts.
Names of the fields that can be modified with this command:
- classification
- custom1
- custom2
- custom3
- hostname
For example, setting custom1 to Example value, setting custom2 to value,value2, and setting hostname to examplehost:
$ ssh-mgr-client modify-host -d \
'custom1=Example value,custom2=value,value2,hostname=examplehost' -i 999
modify-user
Syntax:
ssh-mgr-client modify-user [options] \
(-I <id-filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Set the custom-data fields of the selected user.
In input data (-d), specify the fields and their new values in columnname=value format. Any existing values for the specified fields are overwritten using the new values.
Select the user by ID (-i), or by using matching ID filters (-I). For ID filtering, you can use the same attributes that are available for the listusers command (described in list-users).
For a similar command that can target multiple users at once, see edit-users.
Names of the fields that can be modified with this command:
- custom1
- custom2
- custom3
For example, setting custom1 to Example value, and setting custom2 to value,value2:
$ ssh-mgr-client modify-user -d \
'custom1=Example value,custom2=value,value2' -i 999
redeploy-hosts
Syntax:
ssh-mgr-client [global_options] redeploy-hosts \
(-F <filter> | -i <id>) [-B] [-p <priority>]
Prepare the target hosts for redeployment.
You can select a host by providing its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
In practice, this command just switches the target hosts to the available state, after which you can perform a deploy-host action on the target hosts.
Example - Redeploying hosts in a certain domain:
$ ssh-mgr-client redeploy-hosts -F hostname="*.example.com" -B
$ ssh-mgr-client deploy-hosts -F hostname="*.example.com"
scan-hosts
Syntax:
ssh-mgr-client scan-hosts [options] (-F <filter> | -i <id>) \
[-vvv] [-U <url>] [-o <format>] [-B] [-T <timeout>] [-p <priority>]
Starts a full scan on the selected hosts.
You can select a host by providing its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
The command launches scan-full jobs for scanning the selected hosts. Information about the hosts is updated in Key Manager as soon as the jobs finish.
For more information about host scans, including details about different types of host scans, see Scan Types.
For example, to scan the host that has a certain ID:
$ ssh-mgr-client scan-hosts -i 8
To scan the host named example.server.com:
$ ssh-mgr-client scan-hosts -F "hostname=example.server.com"
As another example, to scan all the Linux hosts, the IP address of which starts with 10:
$ ssh-mgr-client scan-hosts -F "os=linux&&ip=10*"
scan-hosts-authorized-keys
Syntax:
ssh-mgr-client scan-hosts-authorized-keys [options] (-F <filter> | -i <id>) \
[-vvv] [-U <url>] [-o <format>] [-B] [-T <timeout>] [-p <priority>]
Starts an authorized-key scan on the selected hosts.
You can select a host by providing its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
The command launches scan-authorized-keys jobs for scanning the selected hosts. Information about the hosts is updated in Key Manager as soon as the jobs finish.
For more information about host scans, including details about different types of host scans, see Scan Types.
For example, to scan the host that has a certain ID:
$ ssh-mgr-client scan-hosts-authorized-keys -i 8
To scan the host named example.server.com:
$ ssh-mgr-client scan-hosts-authorized-keys -F "hostname=example.server.com"
As another example, to scan all the Linux hosts, the IP address of which starts with 10:
$ ssh-mgr-client scan-hosts-authorized-keys -F "os=linux&&ip=10*"
scan-hosts-configs
Syntax:
ssh-mgr-client scan-hosts-configs [options] (-F <filter> | -i <id>) \
[-vvv] [-U <url>] [-o <format>] [-B] [-T <timeout>] [-p <priority>]
Starts a configuration scan on the selected hosts.
You can select a host by providing its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
The command launches scan-configs jobs for scanning the selected hosts. Information about the hosts is updated in Key Manager as soon as the jobs finish.
For more information about host scans, including details about different types of host scans, see Scan Types.
For example, to scan the host that has a certain ID:
$ ssh-mgr-client scan-hosts-configs -i 8
To scan the host named example.server.com:
$ ssh-mgr-client scan-hosts-configs -F "hostname=example.server.com"
As another example, to scan all the Linux hosts, the IP address of which starts with 10:
$ ssh-mgr-client scan-hosts-configs -F "os=linux&&ip=10*"
scan-hosts-key-activity
Syntax:
ssh-mgr-client scan-hosts-key-activity [options] (-F <filter> | -i <id>) \
[-vvv] [-U <url>] [-o <format>] [-B] [-T <timeout>] [-p <priority>]
Scan the selected hosts for key activity.
You can select a host by providing its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
The command launches scan-host-key-activity jobs for scanning the selected hosts. Information about the hosts is updated in Key Manager as soon as the jobs finish.
For more information about host scans, including details about different types of host scans, see Scan Types.
For example, to scan the host that has a certain ID:
$ ssh-mgr-client scan-hosts-configs -i 8
For example, to scan the host named example.server.com:
$ ssh-mgr-client scan-hosts-key-activity -F "hostname=example.server.com"
As another example, to scan all the Linux hosts, the IP address of which starts with 10:
$ ssh-mgr-client scan-hosts-key-activity -F "os=linux&&ip=10*"
show-host
Syntax:
ssh-mgr-client show-host -i <id> [options] \
[-vvv] [-U <url>] [-o <format>] [-C <columns>]
Displays the host with the given ID.
For output formatting, you can use similar attributes as the list-hosts command (see list-hosts).
Example:
$ ssh-mgr-client show-host -i 3
To also show the FQDN value of the host:
$ ssh-mgr-client show-host -i 3 -C ips
show-user
Syntax:
ssh-mgr-client [-v] [-U <url>] [-o <format>] [-C <columns>] show-user -i <id>
Displays the user with the given ID.
For output formatting, you can use similar attributes as the list-users command (see list-users).
Example:
$ ssh-mgr-client show-user -i 3
suspend-hosts
Syntax:
ssh-mgr-client [-v] [-U <url>] suspend-hosts (-F <filter> | -i <id>)
Switches the management state of the selected hosts to suspended.
Select a host by specifying its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
For example, to suspend a host with a certain ID:
$ ssh-mgr-client suspend-hosts -i 8
As another example, to suspend all the Linux hosts:
$ ssh-mgr-client suspend-hosts -F "os=linux"
tag-hosts
Syntax:
ssh-mgr-client tag-hosts [options] \
(-F <filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Tags selected hosts.
Specify the tag by the name of the tag. If the tag does not exist, it will be created automatically.
You can select a host using its ID. Alternatively, you can select multiple hosts using filters. For filtering (-F), you can use the same attributes that are available for the list-hosts command (see list-hosts).
For example, to tag the host that has the ID of 36, with the tag named to_be_scanned:
$ ssh-mgr-client tag-hosts -i 36 -d tags="to_be_scanned"
As another example, to tag all the Linux hosts:
$ ssh-mgr-client tag-hosts -F "os=linux" -d tags="to_be_scanned"
tag-users
Syntax:
ssh-mgr-client tag-users [options] \
(-F <filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Tags selected users.
Specify the tag by the name of the tag. If the tag does not exist, it will be created automatically.
You can select a user by their ID. Alternatively, you can select multiple users using filters. For filtering (-F), you can use the same attributes that are available for the list-users command (see list-users).
For example, to tag the user that has the ID of 36, with the tag named to_be_reviewed:
$ ssh-mgr-client tag-users -i 36 -d tags="to_be_reviewed"
unmanage-hosts
Syntax:
ssh-mgr-client [-v] [-U <url>] unmanage-hosts (-F <filter> | -i <id>)
Switches the management state of the selected hosts to monitored.
Select a host by specifying its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
For example, to unmanage a host with a certain ID:
$ ssh-mgr-client unmanage-hosts -i 8
As another example, to unmanage all the Linux hosts:
$ ssh-mgr-client unmanage-hosts -F "os=linux"
untag-hosts
Syntax:
ssh-mgr-client untag-hosts [options] \
(-F <filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Removes a tag from the selected host(s).
Specify the tag by the name of the tag.
You can select a host using its ID. Alternatively, you can select multiple hosts using filters. For filtering (-F), you can use the same attributes that are available for the list-hosts command (see list-hosts).
Example:
$ ssh-mgr-client untag-hosts -i 36 -d tags="to_be_reviewed"
untag-users
Syntax:
ssh-mgr-client untag-users [options] (-F <filter> | -i <id>) -d <data> [-vvv] [-U <url>]
Remove a tag from the selected user(s).
Specify the tag by the name of the tag.
You can select a user by their ID. Alternatively, you can select multiple users using filters. For filtering (-F), you can use the same attributes that are available for the list-users command (see list-users).
Example:
$ ssh-mgr-client untag-users -i 36 -d tags="to_be_reviewed"
update-hosts
Syntax:
ssh-mgr-client update-hosts (-F <filter> | -i <id>)
On the selected hosts, run jobs that are in the Held state. This command is used for manually starting jobs when Key Manager is running in mediated mode.
Select a host by specifying its ID (-i). Alternatively, you can select multiple hosts using filters (-F). For filtering, you can use similar attributes as the list-hosts command (see list-hosts).
For example, to start all the held jobs on the host example.server.com:
$ ssh-mgr-client update-hosts -F "hostname=example.server.com"