Dell EMC OpenManage Enterprise 3.9 RESTful API Guide

PDF

POST method for Jobs

This method creates a job.

Description

Creates a job.

Privilege

JOB_MANAGEMENT

HTTP response code

201

Example request body

{
  "Id":0,
  "JobName":"Inventory Task Device",
  "JobDescription":"Inventory Task Device",
  "Schedule":"startnow",
  "State":"Enabled",
  "JobType":
  {
    "Id":8,
    "Name":"Inventory_Task"
  },
  "Targets":
  [
    {
      "Id": 25915,
      "Data": "",
      "TargetType":
      {
        "Id":1000,
        "Name":"DEVICE"
      }
    }
  ]
}

Example response body

{
  "Id": 26097,
  "JobName": "Inventory Task Device",
  "JobDescription": "Inventory Task Device",
  "NextRun": null,
  "LastRun": null,
  "StartTime": null,
  "EndTime": null,
  "Schedule": "startnow",
  "State": "Enabled",
  "CreatedBy": "root",
  "UpdatedBy": null,
  "LastRunStatus":
  {
    "Id": 2200,
    "Name": "NotRun"
  },
  "JobType":
  {
    "Id": 8,
    "Name": "Inventory_Task",
    "Internal": false
  },
  "JobStatus":
  {
    "Id": 2080,
    "Name": "New"
  },
  "Targets":
  [
    {
      "JobId": 26097,
      "Id": 25915,
      "Data": "",
      "TargetType":
      {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ],
  "Params": [],
  "Visible": true,
  "Editable": true,
  "Builtin": false
}

Table 1. AttributesThis table lists the attributes that this method supports.
Attribute	Description
Target Id	ID of the device.
SlotNumber	The supported slot numbers are: 1-8 for computes 1-6 for IOMs
Slot Type	The supported slot types are: 2000 for computes 4000 for IOM
PowerState	The supported values are: 2 (Power On)—Transitions the system to "power on" state. The corresponding ACPI state is G0/S0. 5 (Power Cycle (Off Soft))—Turns off the system. The corresponding ACPI state is G2/S5, in which the system consumes a minimal amount of power. The system, then, transitions to "power on" state. The corresponding ACPI state for "power on" is G0/S0. 8 (Power Off – Soft Non-Graceful)—Transitions the system to off state. The corresponding ACPI state G2/S5, in which the system consumes a minimal amount of power. 10 (Active Bus Reset)—Performs hardware reset on the system. 12 (Power Off - Soft Graceful)—Performs an orderly transition to "power off" state. The corresponding ACPI state is G2/S5, in which the system consumes a minimal amount of power.
Override	Ignores device state and performs the operation
upInterfaceIds	Id of the port that must be configured or switched. If there are multiple ports, a "," is used in the parameter to separate them.
mtuSize	You can determine the MinMtu and MaxMtu for a port from /DeviceService/Devices(id)/InventoryDetails('portInformation'). The mtuSize must be a value within this range.
Target	Device ID retrieved from /api/DeviceService/Devices
logSelector	The supported values are: 0—collect hardware logs 1—collect operating system logs 2—collect raid controller logs
shareType	The supported share types are: NFS CIFS HTTPS
Reboot Type	The supported values are: 1—PowerCycle 2—Graceful reboot without forced shutdown 3—Graceful reboot with forced shutdown