Skip to main content

iDRAC9 Redfish API Guide Firmware version: 4.20.20.20

PDF

JobCollection

Description

This resource is used to represent a Resource Collection of Job instances for a Redfish implementation.

URL

/redfish/v1/JobService/Jobs

Supported HTTP Method and Privileges


HTTP Method	Required Privilege
GET	Login
POST	ConfigureComponents, Login

NOTE A star (*) indicates a required parameter, else the parameter is optional.


Parameter	Type	Value	Description
Payload*	String		This object contains information detailing the HTTP and JSON payload information for executing this job.
TargetUri*	String		The URI of the target for this job. Sample URIs: /redfish/v1/Systems/<System-Id>/Actions/ComputerSystem.Reset /redfish/v1/Chassis/<Chassis-Id>/Actions/Chassis.Reset /redfish/v1/Managers/<Manager-Id>/Actions/Manager.Reset /redfish/v1/Systems/<System-Id>/Storage/Volumes/<Volume-Id>/Actions/Volume.CheckConsistency /redfish/v1/Managers/<Manager-Id>/LogServices/Sel/Actions/LogService.ClearLog
EnabledDaysOfMonth	Array		Days of month when scheduled occurrences are enabled. Zero indicates that every day of the month is enabled.
NOTE Adding a value of 28 or above will automatically schedule the job for last day of the month.
EnabledDaysOfWeek	Array	Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday, Every	Days of the week when scheduled occurrences are enabled, for enabled days of month and months of year.
InitialStartTime	String		This value is a date and time of day on which the initial occurrence is scheduled to occur.
Lifetime	String		The time after provisioning when the schedule as a whole expires. For example, to configure for a year, use the sample value "Lifetime" : "P365D".
MaxOccurrences	INT		Maximum number of scheduled occurrences.
Name	String		The Schedule name.
RecurrenceInterval	String		Distance until the next occurrences. The value shall be a Redfish Duration describing the time until the next occurrence. For example, to configure the reoccurrence to every 90 days, use the sample value "RecurrenceInterval" : "P90D".
NOTE While scheduling a job, if RecurrenceInterval's value is added with a decimal in it, then the job will still be created with the value truncated to the whole number preceding the decimal.

Table 1. Status codes
HTTP status code	Extended Information	Error Code
200