schedule_job

This API schedules a specified job type to run at a specific time.

Note: Some job types do not require an object name. No validation is performed on the object name parameter for the following job types. When you run the API with anything entered as the objectName parameter, the standard 'OK' prompt is returned:
  • AppUserTranslation
  • CSVExport
  • DataArchive
  • DataExport
  • DataImport
  • InstallPolicy
  • IpHostToAlias
  • ResultsArchive
  • SystemBackup

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/schedule_job

GuardAPI syntax

schedule_job parameter=value

Parameters

Parameter Value type Description
cronString String Required.
jobType String Required. For valid values, call schedule_job from the command line with --help=true.
objectName String  
startTime Date  
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.