Device Firmware Update Policy

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.

API Calls
Get

/V5/policies/devicefirmwareupdate

Post

/V5/policies/devicefirmwareupdate

Getting Device Firmware Update Policy

Description Fetches details of the firmware update policy.
Who Can Execute? Superuser, Administrator, Operator, and Viewer.
Syntax
GET <Base_URL>/policies/devicefirmwareupdate?locationid=<value>&nodeid=<value>&default=<value>
  • locationid

    It is an integer value specifying the location for which the list of groups is to be fetched. To retrieve the value for location id refer Location call.

  • nodeid

    It is an integer value specifying the node in a server cluster setup.

  • default
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/policies/devicefirmwareupdate?locationid=0&nodeid=0
Request Body This API call does not require any request body parameters.
Response Body If the API call is successful, the HTTP response status is 200. The response body contains details of the firmware update policy. The response is in the application/json format.

Set Device Firmware Update Policy

Description Sets the firmware update policy.
Who Can Execute? Superuser, Administrator, and Operator.
Syntax
GET <Base_URL>/policies/devicefirmwareupdate?locationid=<value>&nodeid=<value>&default=<value>
Sample code
GET https://training.mojonetworks.com/new/webservice/V5/policies/devicefirmwareupdate?locationid=0&nodeid=0
Request Body The api call requires firmware update details in the request body. The parameters are passed in the application/json format.

The sample request body is as follows:

{
	"scheduledDeviceUpgradeEnabled": false,
	"newDeviceUpgradeEnabled": false,
	"scheduledDeviceUpgradeRecursiveApply": false,
	"newDeviceUpgradeRecursiveApply": false,
	"firmwareUpdateConfigForSchedule": {
		"useLatestFirmwareForAllModels": true,
		"updateOtherModelsToLatest": false
	},
	"firmwareUpdateConfigForNewDevices": {
		"useLatestFirmwareForAllModels": true,
		"updateOtherModelsToLatest": true
	}
}
Response Body If the API call is successful, the HTTP response status is 204.
The response body does not contain any other information.
JSON Table

Attribute Data Type Description Default/Sample value
type string Category or type of the device whose details are being modified. The applicable value is ap ap
boxId long Syatem-generated ID of the AP. 2
name String Name of the device. Mojo_90:64:10
radios application/json A JSON object with attributes related to the access point radio

Sample JSON 
{
	"policyCreatedAtLocId": {
		"type": "locallocationid",
		"id": 0
	},
	"policyType": "DEVICE_UPGRADE",
	"scheduledDeviceUpgradeEnabled": false,
	"newDeviceUpgradeEnabled": false,
	"hitlessDeviceUpgradeEnabled": false,
	"hitlessDeviceUpgradeRecursiveApply": false,
	"schedule": {
		"scheduleId": 0,
		"locationId": null,
		"recurringSchedule": false,
		"onetimeDeviceUpgradeSchedule": {
			"startDateTime": "000000",
			"upgradeWindowDuration": {
				"minutes": 0
			}
		},
		"recurringDeviceUpgradeSchedule": null
	},
	"scheduledDeviceUpgradeRecursiveApply": false,
	"newDeviceUpgradeRecursiveApply": false,
	"firmwareUpdateConfigForSchedule": {
		"useLatestFirmwareForAllModels": true,
		"modelConfigurations": {
			"model-x": {
				"updateConfiguration": "LATEST",
				"version": {
					"versionDisplayString": "8.3.1-301.01",
					"version": "8.3.1-301",
					"vendorVersionId": "01"
				}
			}
		},
		"updateOtherModelsToLatest": false
	},
	"firmwareUpdateConfigForNewDevices": {
		"useLatestFirmwareForAllModels": true,
		"modelConfigurations": {
			"model-x": {
				"updateConfiguration": "LATEST",
				"version": {
					"versionDisplayString": "8.3.1-301.01",
					"version": "8.3.1-301",
					"vendorVersionId": "01"
				}
			}
		},
		"updateOtherModelsToLatest": true
	}
}