export_transfer_key

Use this command to export the SSH transfer keys for the central manager and optionally for the managed units in a deployment, for SCP and SFTP file transfers for 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/export_transfer_key

GuardAPI syntax

export_transfer_key parameter=value

Parameters

Parameter Value type Description
host String Required. The remote host to which you send the key pair.
password String Required. The user for the remote host.
user String Required. The password for the remote host user.
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

On the central manager, copy the unique public-transfer-key of each managed unit to the remote host, by entering: 
grdapi export_transfer_key host="remote_host_1" user="user1" password="password" api_target_host=all
On a managed unit, copy the specific, unique, public-transfer-key of the managed unit to the remote host, by entering:
grdapi export_transfer_key host="remote_host_1" user="user1" password="password"