Documentation Suite v24.4.1

Submit Search

POST SSH Servers

The POST /SSH 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 create a new SSH server in Keyfactor Command. This method returns HTTP 200 OK on a success with details for the new SSH server.

Before adding a new SSH server, be sure that you have added at least one server group (see POST SSH Server Groups) and that your Keyfactor Bash Orchestrator The Bash Orchestrator, one of Keyfactor's suite of orchestrators, is used to discover and manage SSH keys across an enterprise. has been registered and approved in Keyfactor Command (see GET Agents).

Tip: The following permissions (see Security Roles and Claims) are required to use this feature:

/ssh/server_admin/

/ssh/enterprise_admin/

SSH actions are affected by ownership on the server group to which the server belongs and limited for users with only the Server Admin (/ssh/server_admin/) role. For more information, see SSH Permissions.

Table 720: POST SSH Servers Input Parameters

Name	In	Description
AgentId	Body	Required. A string indicating the Keyfactor Command reference GUID for the SSH orchestrator controlling the SSH server.
Hostname	Body	Required. A string indicating the hostname of the SSH server.
ServerGroupId	Body	Required. A string indicating the Keyfactor Command reference GUID for the SSH server group to which the server belongs.
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	An integer indicating the port that is configured for SSH on the SSH server. The default is 22.

Table 721: POST 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 object 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. Show schedule details.

Name Description

Off Turn off a previously configured schedule.

Interval

A dictionary that indicates a job scheduled to run every x minutes with the specified parameter. Any interval that is selected in the UI will be converted to minutes when stored in the database.

Name	Description
Minutes	An integer indicating the number of minutes between each interval.

For example, every hour:

Copy

"Interval": {
   "Minutes": 60
}

Daily

A dictionary that indicates a job scheduled to run every day at the same time with the parameter:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).

For example, daily at 11:30 pm:

Copy

"Daily": {
   "Time": "2023-11-25T23:30:00Z"
}

Weekly

A dictionary that indicates a job scheduled to run on a specific day or days every week at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).
Days	An array of values representing the days of the week on which to run the job. These can either be entered as integers (0 for Sunday, 1 for Monday, etc.) or as days of the week (e.g. “Sunday”).

For example, every Monday, Wednesday and Friday at 5:30 pm:

Copy

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2023-11-27T17:30:00Z"
}

Monthly

A dictionary that indicates a job scheduled to run on a specific day or days every month at the same time with the parameters:

Name	Description
Time	The date and time to next run the job. The date and time should be given using the ISO 8601 UTC time format YYYY-MM-DDTHH:mm:ss.000Z (e.g. 2023-11-19T16:23:01Z).
Day	The number of the day, in the month, to run the job.

For example, on the first of every month at 5:30 pm:

Copy

"Monthly": {
   "Day": 1
   "Time": "2023-11-27T17:30:00Z"
}

For example:

Copy

"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 object 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 Group Operations in the Keyfactor Command Reference Guide for more information. Show owner details.

Name	Description
Id	An integer indicating the Keyfactor Command reference ID of the user who holds the owner role on the SSH server group to which the SSH server belongs.
Username	A string indicating the username of the user (in DOMAIN\\username format) who holds the owner role on the SSH server group to which the SSH server belongs.

GroupName A string indicating the SSH server group to which the SSH server belongs. See SSH Server Group Operations 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: See the Keyfactor API Reference and Utility which provides a utility through which the Keyfactor API

An API is a set of functions to allow creation of applications. Keyfactor offers the Keyfactor API, which allows third-party software to integrate with the advanced certificate enrollment and management features of Keyfactor Command. endpoints can be called and results returned. It is intended to be used primarily for validation, testing and workflow

A workflow is a series of steps necessary to complete a process. In Keyfactor Command, it refers to the workflow builder, which allows you to automate event-driven tasks such as when a certificate is requested, revoked or found in a certificate store. development. It also serves secondarily as documentation for the API. The link to the Keyfactor API Reference and Utility is in the dropdown from the help icon (

) at the top of the Management Portal page next to the Log Out button.

Version v24.4.1

On this page: