configure_system_backup

This API is available in Guardium v11.4 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/configure_system_backup

GuardAPI syntax

configure_system_backup parameter=value

Parameters

Parameter Value type Description
accessKey String  
authType String  
backupOptions String Required. Valid values:
  • cfg
  • data
bucketName String  
destHost String  
passwd String  
port Integer  
protocol String Required. For valid values, call configure_system_backup from the command line with --help=true.
region String Valid values:
  • US_EAST_1
  • US_EAST_2
  • US_WEST_1
  • US_WEST_2
  • EU_CENTRAL_1
  • EU_WEST_1
  • EU_WEST_2
  • EU_WEST_3
  • EU_NORTH_1
  • CA_CENTRAL_1
  • AP_SOUTHEAST_1
  • AP_SOUTHEAST_2
  • AP_NORTHEAST_1
  • AP_NORTHEAST_2
  • SA_EAST_1
  • CN_NORTH_1
  • CN_NORTHWEST_1
  • AP_SOUTH_1
  • GovCloud
  • US_GOV_EAST_1
retention Integer  
roleARN String Valid values:
  • Security-Credentials
  • IAM-Role
  • IAM-Instance-Profile
secretKey String  
ssh_keys_active Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 0 (false)
storageClass String Valid values:
  • standard
  • glacier
targetDir String  
userName String  
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.