generate_transfer_key

Use this command to generate individual sets of SSH key pairs for the central manager, and optionally for each managed unit in a deployment, used for SCP and SFTP file transfers of archive, data export, and system backup.

This API is available in Guardium v11.3 and later.

REST API syntax

This API is available as a REST service with the POST method. Call this API as follows: 
POST https://[Guardium hostname or IP address]:8443/restAPI/generate_ssh_keys

GuardAPI syntax

generate_transfer_key parameter=value

Parameters

Parameter Value type Description
api_target_host String

Specifies the target hosts where the API executes. Valid values:
  • all_managed: execute on all managed units but not the central manager
  • all: execute on all managed units and the central manager
  • group:<group name>: execute on all managed units identified by <group name>
  • host name or IP address of a managed unit: specified from the central manager to execute on a managed unit.  For example, api_target_host=10.0.1.123.
  • host name or IP address of the central manager: specified from a managed unit to execute on the central manager. For example, api_target_host=10.0.1.123.

IP addresses must conform to the IP mode of your network. For dual IP mode, use the same IP protocol with which the managed unit is registered with the central manager. For example, if the registration uses IPv6, specify an IPv6 address. The hostname is independent of IP mode and can be used with any mode.

Examples

Enter this commend on the central manager to generate a key pair for the central manager: 
grdapi generate_transfer_key
Enter this commend on the central manager to generate a key pair for the central manager and all managed units: 
grdapi generate_transfer_key api_target_host=all