PUT /updateRepositories/firmware
Use this method to modify information about firmware updates in the updates repository.
Authentication
Authentication with username and password is required.
Request URL
PUT https://{management_server_IP}/updateRepositories/firmware
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| action={action} | Required | Action to take. This can be one of the following values.
A job is created to export files into the .zip file. Use the GET /updateRepositories/firmware/status?taskid={task_id} method (where {task_id} is the subtask ID) to retrieve the subtask status and file name, or use GET /tasks/{job_id} (where {job_id} is the job ID) to retrieve the overall job status. If a job was not successfully started, refer to the response code and response body for details. |
| filetypes={type} | Optional | When action=delete is specified, this query parameter is used. You can specify one of the following values.
|
| with={scope} | Optional | Scope of the action. This can be one of the following values.
|
PUT https://192.0.2.0/updateRepositories/firmware?action=refreshThenAcquire&with=latest
PUT https://192.0.2.0/updateRepositories/firmware?action=refresh&with=latest
PUT https://192.0.2.0/updateRepositories/firmware?action=acquire&with=payload
PUT https://192.0.2.0/updateRepositories/firmware?action=delete&filetypes=payloads
PUT https://192.0.2.0/updateRepositories/firmware?action=delete&filetypes=all
Request body
| Attributes | Required / Optional | Type | Description | ||
|---|---|---|---|---|---|
| cleanUpIf | Required if action is cleanup | String | Indicates which files to deleted. This can be one of the following values.
| ||
| fixids | Required if action is acquire, export, or delete | Array of strings | List of firmware-update IDs to be downloaded or deleted | ||
| mt | Required if action is refresh, refreshThenAcquire, or acquire | Array of strings | List of machine types for which firmware updates are to be refreshed or downloaded. | ||
| os | Required if action is refreshor refresh, | String | Operating system to be refreshed. For firmware updates, this value must be empty (for example, "os":""). | ||
| type | Required if action is refreshor acquire | String | If action=refresh, this value must be catalog. If action=acquire, set this value to | ||
{
"mt": ["7X07,7X08"],
"os": "",
}
{
"mt": ["7X07,7X08"],
"os": "",
"type": "catalog"
}
{
"fixids": [
"brcd_fw_bcsw_nos5.0.1_anyos_noarch",
"brcd_fw_cna_3.2.4.0_linux_32-64",
"brcd_fw_cna_3.2.3.0_linux_32-64",
"lenovo_fw_dsa_dsyte2f-9.61_anyos_32-64"
],
"mt": ["0000"],
"type": "latest"
}
{
"fixids":["nvgy_utl_lxce_ux01h_2.3.0_windows_i386"]
}
{
"cleanUpIf": "notInUse"
}
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
A subset of the following attributes are returned, depending on the specified query parameters.
| Attributes | Type | Description | ||
|---|---|---|---|---|
| jobid | String | Job ID | ||
| taskid | String | Subtask ID | ||
| tasktype | String | Action that was performed. This can be one of the following values.
| ||
| status | String | This can be one of the following values when the action query parameter is export..
| ||
| result | String | This can be one of the following values when the action query parameter is read, refresh, acquire.
| ||
| errorMsg | Array of objects | Information about one or more messages | ||
| messages | Array of objects | Information about a specific message | ||
| id | String | Message identifier of a returned message | ||
| text | String | Message identifier of a returned message | ||
| result | String | The results of the request. This can be one of the following values.
| ||
{
"jobid": "515",
"taskid": "14",
"result": "success",
"errorMsg": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2508I",
"text": "The repository operation has started successfully."
}]
}
}
{
"tasktype": "EXPORTREPOSITORY",
"taskid": "11",
"status": "success",
"errorMsg": {
"result": "informational",
"messages": [{
"id": "FQXHMUP2500I",
"text": "Repository operation completed successfully."
}]
}
}