datamart_update_copy_file_info

This command modifies a user-defined and 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_update_copy_file_info

GuardAPI syntax

datamart_update_copy_file_info parameter=value

Parameters

Parameter Value type Description
destinationHost String Required. Hostname of target server.
destinationPassword String Required if you are using a username and password for authentication. Password for the user specified by destinationUser.
destinationPath String Required. Path to location to store the data mart extraction.
destinationPort String Required. The port number for the destination.
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.
Name String Required. Data mart name
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:
  • 0: Disable
  • 1: Enable
Default = 0
transferMethod String Required. Valid values:
  • SCP
  • FTP
validate Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 1 (true)
withCOMPLETEfile Boolean A complete file is sent after a data file is successfully transferred. Valid values:
  • 0 (false): The marker file is not sent and the data file is prefixed with "DMv2_". For example: DMv2_vmappibm_EXP_SYSTEM_INFO_20170508150000.gz
  • 1 (true): Two files are sent, one with data and another empty file with the word COMPLETE in it. The second file is a marker that the result is complete. The format of the file name is <global prefix ID>_<appliance name>_<datamart name>_<timestamp>.gz, for example: 1234567890123456789_vmappibm_EXP_SYSTEM_INFO_20170508150000.gz2.

Default = 1 (true)
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.

Example

To update the Export:Session Log transfer method to SCP:

grdapi datamart_update_copy_file_info destinationHost=server22 destinationPassword=passpass destinationPath=<destination server> destinationUser=useruser
Name="Export:Session Log" transferMethod=SCP