PUT SSH Servers

The PUT /SSHClosed The SSH (secure shell) protocol provides for secure connections between computers. It provides several options for authentication, including public key, and protects the communications with strong encryption./Servers method is used to update an existing SSH server in Keyfactor Command. This method returns HTTP 200 OK on a success with details for the SSH server.

Tip:  The following permissions (see Security Overview) are required to use this feature:

SSH: ServerAdmin OR
SSH: EnterpriseAdmin

SSH actions are affected by ownership on the server group to which the server belongs and limited for users with only the ServerAdmin role. For more information, see SSH Permissions in the Keyfactor Command Reference Guide.

Important:  Any previously populated fields that are not submitted with their full existing data using this method will be cleared of their existing data. When using this method, you should first do a GET to retrieve all the values for the record you want to update, enter corrected data into the field(s) you want to update, and then submit all the fields using PUT, including the fields that contain values but which you are not changing.

Table 516: PUT SSH Servers Input Parameters

Name

In

 Description
ID Body Required. The Keyfactor Command reference ID for the SSH server. This ID is automatically set by Keyfactor Command.
UnderManagement Body A Boolean indicating whether the SSH server is in inventory only mode (False) or inventory and publish policy mode (True).
Tip:  If the server group associated with the SSH server is in inventory and publish policy mode, you will not be able to configure the server in inventory only mode.
Port Body The port that is configured for SSH on the SSH server. The default is 22.

Table 517: PUT SSH Servers Response Data

Name Description
ID An integer indicating the Keyfactor Command reference ID for the SSH server. This ID is automatically set by Keyfactor Command.
AgentId A string indicating the Keyfactor Command reference GUID for the SSH orchestrator controlling the SSH server.
Hostname

A string indicating the hostname of the SSH server.
ServerGroupId A string indicating the Keyfactor Command reference GUID for the SSH server group to which the server belongs.
SyncSchedule

An array providing the inventory schedule for the SSH server group to which the SSH server belongs. Inventory schedules cannot be set on an individual SSH server basis. The schedule can be off (unset) or one of the supported values. ClosedShow schedule details.

For example:

"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}
UnderManagement A Boolean indicating whether the SSH server is in inventory only mode (False) or inventory and publish policy mode (True).
Tip:  If the server group associated with the SSH server is in inventory and publish policy mode, you will not be able to configure the server in inventory only mode.
Owner

An array that indicates the Active Directory user who owns the server group to which the server belongs. The owner can only be set by a Keyfactor Command user with the SSH Enterprise Admin role. See SSH Server Groups in the Keyfactor Command Reference Guide for more information. ClosedShow owner details.
GroupName A string indicating the SSH server group to which the SSH server belongs. See SSH Server Groups in the Keyfactor Command Reference Guide for more information.
Orchestrator

A string indicating the name the SSH orchestrator provided to Keyfactor Command when it registered. This value is configurable when the orchestrator is installed.

For more information about the orchestrator, see Bash Orchestrator in the Keyfactor Orchestrators Installation and Configuration Guide.
Port An integer indicating the port that is configured for SSH on the SSH server. The default is 22.
Tip:  For code examples, see the Keyfactor API Endpoint Utility. To find the embedded web copy of this utility, click the help icon () at the top of the Keyfactor Command Management Portal page next to the Log Out button.