datamart_validate_copy_file_info
This command validates the connection to the target host for user-defined or predefined file data mart export.
This API is available in Guardium V9.5 and later.
REST API syntax
This API is available as a REST service with the
PUT
method. Call this API as follows:
PUT https://[Guardium hostname or IP address]:8443/restAPI/datamart_validate_copy_file_info
GuardAPI syntax
datamart_validate_copy_file_info parameter=value
Parameters
Parameter | Value type | Description |
---|---|---|
destinationHost | String | Required. Hostname of target server. |
destinationPassword | String | Password for the user specified by destinationUser. |
destinationPath | String | Required. Path to location to store the datamart extraction. |
destinationUser | String | Required. User with write access to the destination path. |
failoverDestinationHost | string | If the export to destinationHost fails, then Guardium attempts to export the files to failoverDestinationHost. destinationHost and failoverDestinationHost must have the same credentials and path (destinationPath). The output to get_datamart_info shows the server to which results were last sent. |
ssh_key_active | Boolean | Enables data transfer using the SSH key. Enable the SSH key feature with
the CLI command store system scp-ssh-key-mode on. Generate ssh-key pairs and copy
the public part of the key, public-transfer-key , to the remote host. For more
information, see Enabling ssh-key pairs for data archive, data export, data mart. Valid
values:
|
transferMethod | String | Valid values:
|
transferMethod | String | Valid values:
|
Examples
grdapi datamart_validate_copy_file_info destinationHost=hostname destinationUser=user22 destinationPassword= destinationPath= Name= transferMethod=