Image Managment
Get valid switches for Image Management
Resource Name
/inventory/switches/
Description
Returns all valid switches that are qualified for image upgrade.
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/inventory/switches/
Parameter
| Parameter | Type | Description |
|---|---|---|
| filter | O | Filter Object |
Return Value
Format: JSON
Type: List of Object
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with switch information in string. |
Trigger compatibility check
Resource Name
/imagemanagement/job
Description
Triggers compatibility check on the device and returns the job ID
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/job
Parameter
| Parameter | Type | Description |
|---|---|---|
| saverunningConfig | boolean | Saves the running configuration to switch if value is true. |
| concurrentExec | boolean | Upgrade will happen concurrently if the value is true. |
| executeImmediately | boolean | Upgrade will happen immediately if true. Otherwise will be scheduled. |
| comments | string | Any comments for the upgrade task. |
| jobType | integer | 0 for image upgrade, 2 for compatibility check |
| id | integer | -1 for new job creation. Job Id of the compatibility job for upgrading image. |
| taskList | List |
Information on images for different devices. |
Return Value
Format: JSON
Type: Long
| Attribute Name | Type | Description |
|---|---|---|
| Job ID of the new compatibility task |
Get compatibility check/image upgrade status
Resource Name
/imagemanagement/job/{Job-id}
Description
Gets the compatibility check status
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/job/{job-id}
Parameter
| Parameter | Type | Description |
|---|
Return Value
Format: JSON
Type: ImageInstallTaskList
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with Job status as List of ImageInstallTask. |
Trigger Image upgrade check
Resource Name
/imagemanagement/job
Description
Triggers compatibility check on the device and returns the job ID
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/job
Parameter
| Parameter | Type | Description |
|---|---|---|
| Job | O | Job Object |
Return Value
Format: JSON
Type: Long
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with Job Id information as long. |
Get all upgrade and compatibility check jobs
Resource Name
/imagemanagement/jobs
Description
Gets the compatibility check status
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/jobs
Parameter
| Parameter | Type | Description |
|---|
Return Value
Format: JSON
Type: List of Job
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of Job object. |
Activate a SMU package
Resource Name
/smu/activate
Description
Installs patch
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/smu/activate
Parameter
| Parameter | Type | Description |
|---|---|---|
| SMUInstallJob | O | List of SMUInstallTask |
Return Value
Format: JSON
Type: smuTask
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of SMUInstallTask |
Deactivate an SMU package
Resource Name
/smu/deactivate
Description
Installs patch
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/smu/deactivate
Parameter
| Parameter | Type | Description |
|---|---|---|
| SMUInstallJob | O | List of SMUInstallTask |
Return Value
Format: JSON
Type: smuTask
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of SMUInstallTask |
Get all active SMU packages for a switches
Resource Name
/smu/getactive
Description
Gets the active SMU packages for a switch
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/jobs
Parameter
| Parameter | Type | Description |
|---|---|---|
| EthSwitchList | O | List of all Ethernet Switch IDs |
Return Value
Format: JSON
Type: List of SMUInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of SMUInfo |
Get GIR status for all the switches
Resource Name
/imagemanagement/allsystemmode
Description
Gets the maintenance status for all the switches
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/allsystemmode
Parameter
| Parameter | Type | Description |
|---|---|---|
| Place holder | Place holder | Place holder |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of GIRInfo |
Toggle GIR status for all the switches
Resource Name
/imagemanagement/toggle
Description
Gets the maintenance status for all the switches
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/allsystemmode
Parameter
| Parameter | Type | Description |
|---|---|---|
| GIRInfoList | O | List of GIRInfo |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of GIRInfo |
ISSU image upgrade
Resource Name
/imagemanagement/job
Description
Triggers image upgrade on the device and returns the Job ID.
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/imagemanagement/job
Parameter
| Parameter | Type | Description |
|---|---|---|
| Job | O | Job Object |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with Job Id information as long. |
Get Bootflash content
Resource Name
/repomanagement/fetchfirstlevelfiles
Description
Gets the contents of the bootflash directory.
https Method
POST
URL
https://<dcnm-ip>/fm/fmrest/repomanagement/fetchfirstlevelfiles?type=DEVICE&include=true&ip=
Parameter
| Parameter | Type | Description |
|---|---|---|
| Place holder | Place holder | Place holder |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with FolderContent embedded as entity. |
Get available and total space
Resource Name
/repomanagement/fetchdirsize
Description
Gets the available and total space for bootflash directory.
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/repomanagement/fetchdirsize?type=DEVICE&include=true&ip=
Parameter
| Parameter | Type | Description |
|---|---|---|
| Place holder | Place holder | Place holder |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of RepositoryFile embedded as entity. |
Delete files from the Bootflash
Resource Name
/repomanagement/file
Description
Delete files from bootflash directory.
https Method
DELETE
URL
https://<dcnm-ip>/fm/fmrest/repomanagement/file?path=
Parameter
| Parameter | Type | Description |
|---|---|---|
| Place holder | Place holder | Place holder |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with integer value embedded as entity. |
Get server contents in case of SFTP and SCP
Resource Name
/repomanagement/fetchfirstlevelfiles
Description
Gets the contents of the SFTP and SCP directory.
https Method
GET
URL
https://<dcnm-ip>/fm/fmrest/repomanagement/fetchfirstlevelfiles?type=SERVER&include=true&serverName=
Parameter
| Parameter | Type | Description |
|---|---|---|
| GIRInfoList | O | List of GIRInfo |
Return Value
Format: JSON
Type: List of GIRInfo
| Attribute Name | Type | Description |
|---|---|---|
| Response | O | Response Object with list of GIRInfo |