Skip to main content
Sign Out

Welcome to Dell

My Account
  • Place orders quickly and easily
  • View orders and track your shipping status
  • Enjoy members-only rewards and discounts
  • Create and access a list of your products
  • Manage your Dell EMC sites, products, and product-level contacts using Company Administration.
Sign In Create an Account Dell Financial Services Premier Sign In Partner Program Sign In
Contact Us

Your Dell.com Carts

OpenManage Enterprise Version 3.4 and OpenManage Enterprise - Modular Edition Version 1.20.00 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
}
Updating firmware using Compliance method
Example response body 
{
"JobName": "<Job Name>",
"JobDescription": "<Job Description>",
"Schedule": "<Cron String/Startnow>",
"State": "Enabled",
"JobType": { "Id": 5, Name": "Update_Task" },
"Targets": [ 
{ "Id": <Compute Device ID 1>, "Data": "<NDC/MEZZ FQDD>;<PERC FQDD>;<BIOS FQDD>;<CPLD FQDD>;<OSC FQDD>;<OSD FQDD>;<DIAG FQDD>;<iDRAC FQDD>;<Hard Disk FQDD>;<Backplane FQDD>;", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Compute Device ID N>, "Data":"<NDC/MEZZ FQDD>;<PERC FQDD>;<BIOS FQDD>;<CPLD FQDD>;<OSC FQDD>; <OSD FQDD>;<DIAG FQDD>;<iDRAC FQDD>;<Hard Disk FQDD>;<Backplane FQDD>;", "TargetType":{"Id":1000, "Name":"Device"}}, 
{ "Id": <Storage Device ID 1>, "Data": "<HDD FQDD>;<EMM FQDD>;", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Storage Device ID N>, "Data": "<HDD FQDD>;<EMM FQDD>;", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Chassis Device ID 1>, "Data": "<OME-Modular FQDD>", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Chassis Device ID N>, "Data": "<OME-Modular FQDD>", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Network IOM Device ID 1>, "Data": "<IOM FQDD>", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Network IOM Device ID N>, "Data": "<IOM FQDD>", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Storage IOM Device ID 1>, "Data": "<IOM FQDD>", "TargetType":{"Id":1000, "Name":"Device"}},
{ "Id": <Storage IOM Device ID N>, "Data": "<IOM FQDD>", "TargetType":{"Id":1000, "Name":"Device"}}, ],
"Params": [ { "Key": "complianceReportId", "Value": "<Baseline Id>" },
                { "Key": "repositoryId", "Value": "<Repository Id>"  },
                { "Key": "catalogId", "Value": "<Catalog Id>" },
                { "Key": "operationName", "Value": "INSTALL_FIRMWARE" },
                { "Key": "complianceUpdate", "Value": "true" },
                { "Key": "signVerify", "Value": "true" },
                { "Key": "stagingValue", "Value": "false" }
                { "Key":"rebootType", "Value":"<Reboot Type>"}
] }
Updating firmware using Individual Package method
Example response body 
{
"JobName": "<Job Name>",
"JobDescription": "<Job Description>",
"Schedule": "< Cron String/Startnow >",
"State": "Enabled",
"JobType": { "Id": 5, Name": "Update_Task" },
"Targets": [{"Id":<Target Device ID 1>, "Data":"<Component FQDD=FileToken>;", "TargetType":{"Id":1000, "Name":"Device"}},
{"Id":<Target Device ID 2>, "Data":"<Component FQDD=FileToken>;", "TargetType":{"Id":1000, "Name":"Device"}}, ........
{"Id":<Target Device ID N>, "Data":"<Component FQDD=FileToken>;", "TargetType":{"Id":1000, "Name":"Device"}}, ],
"Params": [ { "Key": "operationName", "Value": "INSTALL_FIRMWARE" },
                { "Key": "complianceUpdate", "Value": "false" },
                { "Key": "signVerify", "Value": "true" },
                { "Key": "stagingValue", "Value": "true" }
                { "Key":"rebootType", "Value":"<Reboot Type>"}

] }
Configuring chassis name
Example response body 
{
"JobName": "Update Chassis Name",
"JobDescription": "Update Chassis Name",
"Schedule": "startnow",
"State": "Enabled",
"Targets": [
{
"Id": 25016,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}
],
"Params": [
{
"Key": "operationName",
"Value": "SET_NAME"
},
{
"Key": "name",
"Value": "MX-7BU258R"
}
],
"JobType": 
{
"Id": 3,
"Name": "DeviceAction_Task"
}
}
Setting slot names for blade servers
Example response body 
{
            "JobName": "Update slot name",
            "JobDescription": "Update slot name",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [
                {
                    "Id": 25016,
                    "Data": "",
                    "TargetType": {
                        "Id": 1000,
                        "Name": "DEVICE"
                    }
                }
            ],
            "Params": [
                {
                    "Key": "slotConfig",
                    "Value": "1|1000|SLED1"
                },
                {
                    "Key": "operationName",
                    "Value": "UPDATE_SLOT_DATA"
                }
            ],
            "JobType": {
                "Id": 3,
                "Name": "DeviceAction_Task"
            }
        }
Quick Deploy of IOM
Example response body 
{
  "JobName": "Quick Deploy Task",
  "JobDescription": "Quick Deploy Task",
  "Schedule": "startnow",
  "State": "Enabled",
  "JobType": {
   "Id": 42,
    "Name": "QuickDeploy_Task"
  },
  "Params": [
    {
      "Key": "operationName",
      "Value": "IOM_QUICK_DEPLOY"
    },
    {
      "Key": "deviceId",
      "Value": "25041"
    },
    {
      "Key": "rootCredential",
      "Value": "password"
    },
    {
      "Key": "networkTypeV4",
      "Value": "Dhcp"
    },
    {
      "Key": "protocolTypeV4",
      "Value": "true"
    },
    {
      "Key": "subnetMaskV4",
      "Value": ""
    },
    {
      "Key": "gatewayV4",
      "Value": ""
    },
    {
      "Key": "networkTypeV6",
      "Value": ""
    },
    {
      "Key": "protocolTypeV6",
      "Value": ""
    },
    {
      "Key": "prefixLength",
      "Value": ""
    },
    {
      "Key": "gatewayV6",
      "Value": ""
    },
     {
      "Key": "slotId=1",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    },
    {
      "Key": "slotId=2",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    },
    {
      "Key": "slotId=3",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    },
    {
      "Key": "slotId=4",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    },
    {
      "Key": "slotId=5",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    },
    {
      "Key": "slotId=6",
      "Value": "SlotSelected=true;SlotType=4000;IPV4Address=;VlanId=;"
    }
  ]
}
Quick Deploy of sleds
Example response body 
{
            "JobName": "Quick Deploy",
            "JobDescription": "New Quick Deploy Configuration",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [],
            "Params": [
                {
                    "Key": "slotId=5",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "slotId=6",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "slotId=7",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "slotId=8",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "operationName",
                    "Value": "SERVER_QUICK_DEPLOY"
                },
                {
                    "Key": "rootCredential",
                    "Value": "calvin"
                },
                {
                    "Key": "deviceId",
                    "Value": "25016"
                },
                {
                    "Key": "protocolTypeV4",
                    "Value": "true"
                },
                {
                    "Key": "slotId=3",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                   "Key": "slotId=2",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "slotId=4",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "slotId=1",
                    "Value": "SlotSelected=true;SlotType=1000;IPV4Address=0.0.0.0;IPV6Address=::;VlanId=1"
                },
                {
                    "Key": "networkTypeV6",
                    "Value": "DHCP"
                },
                {
                    "Key": "networkTypeV4",
                    "Value": "DHCP"
                },
                {
                    "Key": "protocolTypeV6",
                    "Value": "true"
                }
            ],
            "JobType": {
                "Id": 42,
                "Name": "QuickDeploy_Task",
            }
        }
Rolling back firmware update—Device method
Example response body 
{ 
   "JobName":"Rollback Firmware",
   "Schedule":"<crontime/startNow>",                   
   "State":"Enabled",
   "JobType":{ 
      "Id": 15,
      "Name":"RollbackSoftware_Task"
   },
   "Params":[ 
      { 
         "Key":"operationName",
         "Value":"INSTALL_FIRMWARE"
      },
      { 
         "Key":"stagingValue",
         "Value":"false"
      },
      { 
         "Key":"signVerify",
         "Value":"true"
      }
   ],
   "Targets":[ 
      { 
         "Id":<DEVICEID>,
         "Data": "available=<COMPONENTID;>",
         "TargetType":{ 
            "Id":1000,
            "Name":"Device"
         }
      }
   ]
}
Rolling back firmware update—Catalog method
Example response body 
{ 
   "JobName":"Rollback Firmware",
   "Schedule":"<crontime/startNow>",                   
   "State":"Enabled",
   "JobType":{ 
      "Id": 15,
      "Name":"RollbackSoftware_Task"
   },
   "Params":[ 
      { 
         "Key":"operationName",
         "Value":"INSTALL_FIRMWARE"
      },
      { 
         "Key":"stagingValue",
         "Value":"false"
      },
      { 
         "Key":"signVerify",
         "Value":"true"
      }
   ],
   "Targets":[ 
      { 
         "Id":<DEVICEID>,
         "Data": "<CatalogId>=<DUP.EXE>|<COMPONENTID/FQDD;>",
         "TargetType":{ 
            "Id":1000,
            "Name":"Device"
         }
      }
   ]
}
Rolling back firmware update—Browse method
Example response body 
{ 
   "JobName":"Rollback Firmware",
   "Schedule":"<crontime/startNow>",                   
   "State":"Enabled",
   "JobType":{ 
      "Id": 15,
      "Name":"RollbackSoftware_Task"
   },
   "Params":[ 
      { 
         "Key":"operationName",
         "Value":"INSTALL_FIRMWARE"
      },
      { 
         "Key":"stagingValue",
         "Value":"false"
      },
      { 
         "Key":"signVerify",
         "Value":"true"
      }
   ],
   "Targets":[ 
      { 
         "Id":<DEVICEID>,
         "Data": "unavailable= <13 Digit File Token>|<COMPONENTID;>",
         "TargetType":{ 
            "Id":1000,
            "Name":"Device"
         }
      }
   ]
}
Failover of management module
Example response body 
{
            "JobName": "Failover Operation",
            "JobDescription": "Failover Operation",
            "Schedule": "",
            "State": "Enabled",
            "Targets": [
                {
                    "Id": 25039,
                    "Data": "",
                    "TargetType": {
                        "Id": 1000,
                        "Name": "DEVICE"
                    }
                }
            ],
            "Params": [
                {
                    "Key": "operationName",
                    "Value": "FAILOVER"
                }
            ],
            "JobType": {
                "Id": 3,
                "Name": "DeviceAction_Task"
            }
        }
Chassis backup
Example response body 
{            
            "Id": 0,
            "JobName": "Backup Task",
            "JobDescription": "Create a Backup of the chassis",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [],
            "Params": [
                {                    
                    "Key": "shareName",
                    "Value": "Floder_Name"
                },
                {
            
                   "Key": "backup_filename",
                   "Value": "backup file name.bin"
                },
                {                   
                    "Key": "shareType",
                    "Value": "CIFS/NFS"
                },
                {                    
                    "Key": "device_id",
                    "Value": "<Chassis ID>"
                },
                {                   
                    "Key": "shareAddress",
                    "Value": "<IP Address>"
                },
                {                    
                    "Key": "encryption_password",
                    "Value": "<encryption password>"
                },            
                {
                     "Key": "userName",
                     "Value": "<Share username>"
                },
                {
                     "Key": "password",
                     "Value": "<Share user password>"
                }
            ],
            "JobType": {
                "Id": 21,
                "Name": "Backup_Task",
                "Internal": false
            }
}
Chassis restore
Example response body 
{
            
            "Id": 0,
            "JobName": "Restore Task",
            "JobDescription": "Restore an existing device backup"
            "Schedule": "startnow",
            "State": "Enabled",
             "Targets": [],
            "Params": [
                {
                    
                    "Key": "shareType",
                    "Value": "<NFS/CIFS>"
                },
                {
                    
                    "Key": "backup_filename",
                    "Value": "<Backup File name.bin>"
                },
                {
                    
                    "Key": "encryption_password",
                    "Value": "<encryption password>"
                },
                {
                    
                    "Key": "shareAddress",
                    "Value": "<IP Address>"
                },
                {
                   
                    "Key": "shareName",
                    "Value": "<Floder name>"
                },
                {
                   
                    "Key": "device_id",
                    "Value": "<Chassis ID>"
                },
                {
                     "Key": "userName",
                     "Value": "<user name of the network share>"
                },
                {
                     "Key": "password",
                     "Value": "<password of the network share>"
                }
            ],
                       
            "JobType": {
                
                "Id": 20,
                "Name": "Restore_Task",
                "Internal": false
            }
            }
Exporting chassis profiles
Example response body 
{
    "@odata.context": "/api/$metadata#JobService.Job",
    "@odata.type": "#JobService.Job",
    "@odata.id": "/api/JobService/Jobs(13286)",
    "Id": 13286,
    "JobName": "Export Profile",
    "JobDescription": "Create and export profile of the chassis",
    "NextRun": null,
    "LastRun": "2020-06-10 12:33:19.053",
    "StartTime": null,
    "EndTime": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "CreatedBy": "root",
    "UpdatedBy": null,
    "Visible": true,
    "Editable": true,
    "Builtin": false,
    "UserGenerated": true,
    "Targets": [],
    "Params": [
        {
            "JobId": 13286,
            "Key": "shareType",
            "Value": "CIFS"
        },
        {
            "JobId": 13286,
            "Key": "profile_option",
            "Value": "export"
        },
        {
            "JobId": 13286,
            "Key": "password",
            "Value": "EQ32BUg9RN+PoY31J3690IXthTHKwHOXAShI2vnN9xA="
        },
        {
            "JobId": 13286,
            "Key": "userName",
            "Value": "administrator"
        },
        {
            "JobId": 13286,
            "Key": "shareName",
            "Value": "/share"
        },
        {
            "JobId": 13286,
            "Key": "shareAddress",
            "Value": "100.97.204.81"
        }
    ],
    "LastRunStatus": {
        "@odata.type": "#JobService.JobStatus",
        "Id": 2060,
        "Name": "Completed"
    },
    "JobType": {
        "@odata.type": "#JobService.JobType",
        "Id": 22,
        "Name": "ChassisProfile_Task",
        "Internal": false
    },
    "JobStatus": {
        "@odata.type": "#JobService.JobStatus",
        "Id": 2080,
        "Name": "New"
    },
    "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(13286)/ExecutionHistories"
}
Importing chassis profiles
Example response body 
{
    "@odata.context": "/api/$metadata#JobService.Job",
    "@odata.type": "#JobService.Job",
    "@odata.id": "/api/JobService/Jobs(13288)",
    "Id": 13288,
    "JobName": "Import Profile",
    "JobDescription": "Import of backed up chassis profile",
    "NextRun": null,
    "LastRun": "2020-06-10 12:35:09.123",
    "StartTime": null,
    "EndTime": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "CreatedBy": "root",
    "UpdatedBy": null,
    "Visible": true,
    "Editable": true,
    "Builtin": false,
    "UserGenerated": true,
    "Targets": [],
    "Params": [
        {
            "JobId": 13288,
            "Key": "shareType",
            "Value": "CIFS"
        },
        {
            "JobId": 13288,
            "Key": "profile_option",
            "Value": "import"
        },
        {
            "JobId": 13288,
            "Key": "import_file",
            "Value": "7BU0032_1591792399246.txt"
        },
        {
            "JobId": 13288,
            "Key": "shareName",
            "Value": "/share"
        },
        {
            "JobId": 13288,
            "Key": "password",
            "Value": "YU7QIlAT7lPyAeRMZSLxehtm7g68Ygrsa23kRcxMX70="
        },
        {
            "JobId": 13288,
            "Key": "userName",
            "Value": "administrator"
        },
        {
            "JobId": 13288,
            "Key": "shareAddress",
            "Value": "100.97.204.81"
        }
    ],
    "LastRunStatus": {
        "@odata.type": "#JobService.JobStatus",
        "Id": 2060,
        "Name": "Completed"
    },
    "JobType": {
        "@odata.type": "#JobService.JobType",
        "Id": 22,
        "Name": "ChassisProfile_Task",
        "Internal": false
    },
    "JobStatus": {
        "@odata.type": "#JobService.JobStatus",
        "Id": 2080,
        "Name": "New"
    },
    "ExecutionHistories@odata.navigationLink": "/api/JobService/Jobs(13288)/ExecutionHistories"
}
Test connection
Example response body 
{
            "JobName": "Validate Share",
            "JobDescription": "Validate Share",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [],
            "Params": [
                {
                    "Key": "checkPathOnly",
                    "Value": "false"
                },
                {
                    "Key": "shareType",
                    "Value": "<NFS/CIFS>"
                },
                {
                    "Key": "ShareNetworkFilePath",
                    "Value": "<Folder_Path>"
                },
                {
                    "Key": "shareAddress",
                    "Value": "<IP Address>"
                },
                {
                    "Key": "testShareWriteAccess",
                    "Value": "true"
                }
            ],
                "JobType": 
{
                "Id": 56,
                "Name": "ValidateNWFileShare_Task"
            }
        }
Chassis Extract Logs—Local Share
Example response body 
{
            "JobName": "Extract Log",
            "JobDescription": "Extract device log",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [
                {
                    "Id": 25016,
                    "Data": "",
                    "TargetType": {
                        "Id": 1000,
                        "Name": "DEVICE"
                    }
                }
            ],
            "Params": [
                {
                    "Key": "shareAddress",
                    "Value": "127.0.0.1"
                },
                {
                    "Key": "shareName",
                    "Value": "/var/nfsshare"
                },
                {
                    "Key": "OPERATION_NAME",
                    "Value": "EXTRACT_LOGS"
                },
                {
                    "Key": "shareType",
                    "Value": "HTTPS"
                },
                {
                    "Key": "maskSensitiveInfo",
                    "Value": "FALSE"
                }
            ],
            "JobType": {
                "Id": 18,
                "Name": "DebugLogs_Task"
            }
        }
Chassis Extract Logs—NFS Share
Example response body 
{
            "JobName": "Extract Log",
            "JobDescription": "Extract device log to NFS location",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [
                {
                    "Id": 25016,
                    "Data": "",
                    "TargetType": {
                        "Id": 1000,
                        "Name": "DEVICE"
                    }
                }
            ],
            "Params": [
                {
                    "Key": "shareAddress",
                    "Value": "2607:f2b1:f083:218::1f2"
                },
                {
                    "Key": "shareName",
                    "Value": "share"
                },
                {
                    "Key": "OPERATION_NAME",
                    "Value": "EXTRACT_LOGS"
                },
                {
                    "Key": "shareType",
                    "Value": "NFS"
                },
                {
                    "Key": "maskSensitiveInfo",
                    "Value": "FALSE"
                }
            ],
            "JobType": {
                "Id": 18,
                "Name": "DebugLogs_Task"
            }
        }
Chassis Extract Logs—CIFS Share
Example response body 
{
            "JobName": "Extract Log",
            "JobDescription": "Extract device log to CIFS location",
            "Schedule": "startnow",
            "State": "Enabled",
            "Targets": [
                {
                    "Id": 25016,
                    "Data": "",
                    "TargetType": {
                        "Id": 1000,
                        "Name": "DEVICE"
                    }
                }
            ],
            "Params": [
                {
                    "Key": "OPERATION_NAME",
                    "Value": "EXTRACT_LOGS"
                },
                {
                    "Key": "password",
                    "Value": "sharepass"
                },
                {
                    "Key": "userName",
                    "Value": "administrator"
                },
                {
                    "Key": "shareType",
                    "Value": "CIFS"
                },
                {
                    "Key": "shareName",
                    "Value": "cifs"
                },
                {
                    "Key": "shareAddress",
                    "Value": "2607:f2b1:f083:218::1f2"
                },
                {
                    "Key": "maskSensitiveInfo",
                    "Value": "FALSE"
                }
            ],
            "JobType": {
                "Id": 18,
                "Name": "DebugLogs_Task"
            }
        }
Device-based reseat for compute, storage, or IOM
Example response body 
{
"JobName": "Virtual_Reseat",
"JobDescription": " Virtual_Reseat ",
"Schedule": "startnow",
"State":"Enabled",
"Targets": [
{
"Id": 50115,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}
],
"Params": [
{
"Key": "override",
"Value": "true"
},
{
"Key": "operationName",
"Value": "VIRTUAL_RESEAT"
},
{
"Key": "deviceTypes",
"Value": "1000"
}
],
"JobType": {
"Id": 3,
"Name": "DeviceAction_Task",
"Internal": false
}}
Slot-based reseat for compute, storage, or IOM
Example response body 
{
"JobName": "Slot Based Virtual Reseat",
"JobDescription": "Virtual_Reseat_Slot_based",
"Schedule": "startnow",
"State":"Enabled",
"Targets": [
{
"Id": 25045,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}
],
"Params": [
{
"Key": "slotType",
"Value": "2000"
},
{
"Key": "operationName",
"Value": "VIRTUAL_RESEAT"
},
{
"Key": "slotNumber",
"Value": "6"
}
],
"JobType": {
"Id": 3,
"Name": "DeviceAction_Task",
"Internal": false
}}
Chassis power off operation
Example response body 
{
"JobName": "Power Off (Non-graceful)",
"JobDescription": "Power Control Task: Power Off (Non-graceful)",
"Schedule": "startnow",
"State": "Enabled", 
"Targets": [
{
"Id": 50115,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}],
"Params": [
{
"Key": "override",
"Value": "true"
},
{
"Key": "powerState",
"Value": "8"
},
{
"Key": "operationName",
"Value": "POWER_CONTROL"
},
{
"Key": "deviceTypes",
"Value": "1000"
}
],
"JobType": {
"Id": 3,
"Name": "DeviceAction_Task",
"Internal": false
}
}
Blade server (sled) power off operation
Example response body 
{
"JobName": "Power Off (Non-graceful)",
"JobDescription": "Power Control Task: Power Off (Non-graceful)",
"Schedule": "startnow",
"State": "Enabled", 
"Targets": [
{
"Id": 10771,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}],
"Params": [
{
"Key": "override",
"Value": "true"
},
{
"Key": "powerState",
"Value": "8"
},
{
"Key": "operationName",
"Value": "POWER_CONTROL"
},
{
"Key": "deviceTypes",
"Value": "1000"
}
],
"JobType": {
"Id": 3,
"Name": "DeviceAction_Task",
"Internal": false
}
}
IOM power off operation
Example response body 
{
"JobName": "Power Off (Non-graceful)",
"JobDescription": "Power Control Task: Power Off (Non-graceful)",
"Schedule": "startnow",
"State": "Enabled", 
"Targets": [
{
"Id": 10660,
"Data": "",
"TargetType": {
"Id": 1000,
"Name": "DEVICE"
}
}],
"Params": [
{
"Key": "override",
"Value": "true"
},
{
"Key": "powerState",
"Value": "8"
},
{
"Key": "operationName",
"Value": "POWER_CONTROL"
},
{
"Key": "deviceTypes",
"Value": "1000"
}
],
"JobType": {
"Id": 3,
"Name": "DeviceAction_Task",
"Internal": false
}
}
Slot-based iDRAC reset operation
Example response body 
{
  "JobName": "iDRAC Reset_REST",
  "JobDescription": "iDRAC Reset_Slot2",
  "Schedule": "startnow",
  "State": "Enabled",
  "Targets": [
    {
      "Id": 10099,
      "Data": "",
      "TargetType": {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ],
  "Params": [
    {
      "Key": "slotNumber",
      "Value": "2"
    },
    {
      "Key": "operationName",
      "Value": "RESET_IDRAC"
    },
    {
      "Key": "slotType",
      "Value": "2000"
    }
  ],
  "JobType": {
    "Id": 3,
    "Name": "DeviceAction_Task",
    "Internal": false
  }
}
Where Slot type is always 2000 for compute SLED and ID "10099" is for chassis ID.
Configuring Forward Error Correction (FEC) for IOM ports
Example response body 
{
    "JobName": "Configure FEC",
    "JobDescription": "Configure Forward Error Correction",
    "Schedule": "startnow",
    "State": "Enabled",
    "JobType": {
        "Id": 3,
        "Name": "DeviceAction_Task"
    },
    "Targets": [
        {
            "Id": 10073, "<deviceId for the IOM in MSM>"
            "Data": "",
            "TargetType": {}
        }
    ],
    "Params": [
        {
            "Key": "operationName",
            "Value": "CONFIGURE_FEC_OPTICS"
        },
        {
            "Key": "interfaceId",
            "Value": "53F2PK2:ethernet1/1/10:1" "<Port Id>"
        },
        {
            "Key": "fecValue",
            "Value": "xx"  "<Fec value to be configured>"
        }
    ]
}
Force reset of management module (MM)
Example response body 
 {
   "Id":0,
   "JobName":"DeviceAction_Tasktest",
   "JobDescription":"DeviceAction_Task",
   "Schedule":"startnow",
   "State":"Enabled",
   "JobType":{
      "Id":3,
      "Name":"DeviceAction_Task"
   },
   "Params":[
     {
         "Key":"operationName",
         "Value":"EC_RESET"
      },
      {
        "Key":"forceReset",
         "Value":"true"
      }
],
   "Targets":[
      {
         "Id":10054,
         "Data":"",
         "TargetType":{
            "Id":1000,
            "Name":"Device"
         }
      }
   ]
}
Blink LED
Example response body 
{
  "Id": 0,
  "JobName": "Blink LED",
  "JobDescription": "Blink LED: N Minute(s) or Indefinitely",
  "Schedule": "startnow",
  "State": "Enabled",
  "JobType": {
    "Name": "DeviceAction_Task"
  },
  "Targets": [
    {
      "Id": 10043,
      "Data": "",
      "TargetType": {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ],
  "Params": [
    {
      "Key": "identifyState",
      "Value": "2" // 2 = duration in minutes, -1= indefinitely
    },
    {
      "Key": "durationLimit",
      "Value": "60" // 60= 1 minute, 600=10 minutes, 1800=30 minutes, -1= indefinitely
    },
    {
      "Key": "operationName",
      "Value": "IDENTIFY_BLINK_LED"
    }
  ]
}
NOTE: To shut off LED blinking the identifyState and durationLimit parameters must be set to 0.
Power Cycle System (Cold Boot)
Example response body 
{
  "Id": 0,
  "JobName": "Power Cycle System (Cold Boot)",
  "JobDescription": "Power Control Task: Power Cycle System (Cold Boot)",
  "State": "Enabled",
  "Schedule": "startnow",
  "JobType": {
    "Name": "DeviceAction_Task"
  },
  "Targets": [
    {
      "Id": 10043,
      "Data": "",
      "TargetType": {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ],
  "Params": [
    {
      "Key": "override",
      "Value": "true"
    },
    {
      "Key": "powerState",
      "Value": "5"
    },
    {
      "Key": "operationName",
      "Value": "POWER_CONTROL"
    },
    {
      "Key": "deviceTypes",
      "Value": "1000"
    }
  ]
}
System reseat
Example response body 
{
  "Id": 0,
  "JobName": "System Reseat",
  "JobDescription": "Power Control Task: System Reseat",
  "State": "Enabled",
  "Schedule": "startnow",
  "JobType": {
    "Name": "DeviceAction_Task"
  },
  "Targets": [
    {
      "Id": 10043,
      "Data": "",
      "TargetType": {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ],
  "Params": [
    {
      "Key": "operationName",
      "Value": "VIRTUAL_RESEAT"
    }
  ]
}
Reset iDRAC
Example response body 
{
    "JobName": "Reset iDRAC",
    "JobDescription": "Reset iDRAC",
    "Schedule": "startnow",
    "State": "Enabled",
    "JobType":
    { 
        "Id": 3,
        "Name": "DeviceAction_Task",
        "Internal": false
    },
    "Params":
    [
        {"Key": "operationName", "Value": "RESET_IDRAC"}
    ],
    "Targets":
    [
        {
            "Id": 10043,
            "Data": "",
            "TargetType": 
            {
                "Id": 1000,
                "Name": "DEVICE"
            }
        }
    ]
}
Configure Port Break Out
Example response body 
{
    "JobName": "Breakout Port",
    "JobDescription": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "JobType":
    { 
        "Id": 3,
        "Name": "DeviceAction_Task",
        "Internal": false
      },
    "Targets":
    [
      {
            "Id": 10045,
            "Data": "",
            "TargetType": { "Id": 1000, "Name": "DEVICE" }
        }
    ],
    "Params": 
    [
        {"Key": "breakoutType", "Value": “FabricExpander"},
        {"Key": "interfaceId", "Value": "DPM4XC1:port-group1/1/1,DPM4XC1:port-group1/1/2" },
        { "Key": "operationName", "Value": "CONFIGURE_PORT_BREAK_OUT" }
    ]
}
Toggle port status
Example response body 
{
    "JobName": "Toggle Port",
    "JobDescription": null,
    "State": "Enabled",
    "JobType":
    { 
        "Id": 3,
        "Name": "DeviceAction_Task",
        "Internal": false
      },
    "Targets":
    [
      {
            "Id": 10043,
            "Data": "",
            "TargetType": { "Id": 1000, "Name": "DEVICE" }
        }
    ],
    "Params": 
    [
      {"Key": "upInterfaceIds", "Value": "DPM4XC1:port-group1/1/1"},
      {"Key": "operationName", "Value": "TOGGLE_PORT_STATUS"}
    ]
}
Configure MTU
Example response body 
{
    "JobName": "Update Maximum Transmission Unit",
    "JobDescription": null,
    "Schedule": "startnow",
    "State": "Enabled",
    "JobType":
    { 
        "Id": 3,
        "Name": "DeviceAction_Task",
        "Internal": false
      },
      "Targets":
      [
            {
            "Id": 25029,
            "Data": "",
            "TargetType": { "Id": 1000, "Name": "DEVICE" }
            }
      ],
      "Params":
      [
            {"Key":"operationName", "Value":"CONFIGURE_MTU_SPEED"},
            {"Key":"mtuSize", "Value":"1500"},
            {"Key":"interfaceId", "Value DPM4XC1:port-group1/1/1"}
      ]
}
Group Inventory
Example response body 
{
  "Id": 0,
  "JobName": "Default Inventory Task - All Devices ",
  "JobDescription": "Default Inventory Task - All Devices",
  "Schedule": "startnow",
  "State": "Enabled",
  "JobType": {
    "Name": "Inventory_Task"
  },
  "Targets": [
    {
      "Id": 500,
      "Data": "",
      "TargetType": {
        "Id": 6000,
        "Name": "GROUP"
      }
    }
  ]
}
Device Inventory
Example response body 
{
  "Id": 0,
  "JobName": "Default Inventory Task - All Devices ",
  "JobDescription": "Default Inventory Task - All Devices",
  "Schedule": "startnow",
  "State": "Enabled",
  "JobType": {
    "Name": "Inventory_Task"
  },
  "Targets": [
    {
      "Id": <device_id>,
      "Data": "",
      "TargetType": {
        "Id": 1000,
        "Name": "DEVICE"
      }
    }
  ]
}
Extracting device logs
Example response body 
{
    "Id": 0,
    "JobName": "Extract Log",
    "JobDescription": "Extract device log to CIFS location",
    "Schedule": "startnow",
    "State": "Enabled",
    "JobType": {
      "Id": 18,
      "Name": "DebugLogs_Task"
    },
    "Targets": [
      {
        "Id": 10036,
        "TargetType": {
          "Id": 1000,
          "Name": "DEVICE"
        }
      }
    ],
    "Params": [
      {
        "Key": "OPERATION_NAME",
        "Value": "EXTRACT_LOGS"
      },
      {
        "Key": "shareAddress",
        "Value": "100.69.127.105"
      },
      {
        "Key": "shareName",
        "Value": "\\cifs\\share"
      },
      {
        "Key": "shareType",
        "Value": "CIFS"
      },
      {
        "Key": "userName",
        "Value": "user-provided-user-name"
      },
      {
        "Key": "password",
        "Value": "user-provided-password"
      },
      {
        "Key": "domainName",
        "Value": "org-domain-name"
      },
      {
        "Key": "maskSensitiveInfo",
        "Value": "TRUE"
      }
    ]
  }
Extracting SupportAssist collection
Example response body 
{ 
    "Id":0,
    "JobName":"Extract SupportAssist Collection",
    "JobDescription":"Extract SupportAssist Collection to NFS location",
    "Schedule":"startnow",
    "State":"Enabled",
    "JobType":{ 
       "Id":18,
       "Name":"DebugLogs_Task"
    },
    "Targets":[ 
       { 
          "Id":10038,
          "TargetType":{ 
             "Id":1000,
             "Name":"DEVICE"
          }
       }
    ],
    "Params":[ 
       { 
          "Key":"OPERATION_NAME",
          "Value":"EXTRACT_LOGS"
       },
       { 
          "Key":"shareType",
          "Value":"NFS"
       },
       { 
          "Key":"shareAddress",
          "Value":"1.2.3.4"
       },
       { 
          "Key":"shareName",
          "Value":"filepath"
       },
       { 
          "Key":"logSelector",
          "Value":"0,1,2"
       }
    ]
 }
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 (Master 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 toggled. If there are multiple ports these are separated by a "," in the parameter.
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 os 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

Rate this content

Accurate
Useful
Easy to understand
Was this article helpful?
0/3000 characters
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please provide ratings (1-5 stars).
  Please select whether the article was helpful or not.
  Comments cannot contain these special characters: <>()\