POST SSH Server Groups

Documentation Suite v10.1

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./ServerGroups method is used to create an SSH server groups defined in Keyfactor Command. This method returns HTTP 200 OK on a success with details for the new SSH server group.

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

SSH: EnterpriseAdmin

Table 530: POST SSH Server Groups Input Parameters

Name

Description

OwnerName

Body

Required. A string indicating the Active Directory user who owns the server group (in DOMAIN\\username format). 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.

Tip: Notice that the field name and structure returned on a GET is not the same as that used on a POST and PUT for the server group owner.

GroupName

Body

Required. A string indicating the name of the SSH server group.

SyncSchedule

Body

An array providing the inventory schedule for the SSH server group. 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

A parameter or argument is a value that is passed into a function in an application.. 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:

"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. 2021-05-19T16:23:01Z).

For example, daily at 11:30 pm:

"Daily": {
   "Time": "2022-02-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. 2021-05-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:

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2022-02-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. 2021-05-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:

"Monthly": {
   "Day": 1
   "Time": "2022-02-27T17:30:00Z"
}

For example:

"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}

The default is unset.

UnderManagement

Body

A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True). The default is False.

Table 531: POST SSH Server Groups Response Data

Name

Description

A string indicating the Keyfactor Command reference GUID for the SSH server group. This GUID is automatically set by Keyfactor Command.

Owner

An object indicating the Active Directory user who owns the server group. See SSH Server Groups 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.
Username	A string indicating the username of the user (in DOMAIN\\username format) who holds the owner role on the SSH server group.

GroupName

A string indicating the name of the SSH server group.

SyncSchedule

An array providing the inventory schedule for the SSH server group. 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:

"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. 2021-05-19T16:23:01Z).

For example, daily at 11:30 pm:

"Daily": {
   "Time": "2022-02-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. 2021-05-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:

"Weekly": {
   "Days": [
      "Monday",
      "Wednesday",
      "Friday"
   ],
   "Time": "2022-02-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. 2021-05-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:

"Monthly": {
   "Day": 1
   "Time": "2022-02-27T17:30:00Z"
}

For example:

"SyncSchedule": {
   "Weekly": {
      "Days": [
         "Monday",
         "Wednesday",
         "Friday"
      ],
      "Time": "2022-11-20T14:00:00Z"
   }
}

UnderManagement

A Boolean indicating whether the SSH server group is in inventory only mode (False) or inventory and publish policy mode (True).

ServerCount

An integer indicating the number of SSH servers that belong to the server group.

POST SSH Server Groups

Products

Solutions

Resources

Company