DevicePatchBodySpec

object

autoPreloadLatestSoftware

• type: boolean
• optional: true
• default: false
  Whether the device should automatically preload the latest available software version.

availableNetworks

• type: list of objects AvailableNetworkFragment
• optional: true
  The list of glossary:networks available to the device and, optionally, the interfaces they are connected to. Leave the available networks list empty to give the device access to all of the networks with routes to the device's glossary:site. Read Available networks to learn more.

Show 2 properties

Hide 2 properties

interfaceName

• type: string
• required: true
• pattern: \[^\s\/]{1,16}
  The name of the <<glossary:device interface>> that will be connected to the network.

networkName

• type: string
• required: true
• pattern: ^a-z0-9?$
  The name of the glossary:network that will be made available to this device.

desiredSoftwareVersion

• type: string
• optional: true
• maxLength: 255
  The desired version of software that should be running on the device.

geolocation

• type: object GeolocationFragment
• optional: true
  Optional geolocation data for the device.

Show 1 property

Hide 1 property

coordinates

• type: list of doubles
• required: true
• items: 0-2
  Co-ordinates that describe the geolocation (ISO 6709), an array of two floating point numbers [latitude(North - South), longitude(East - West)]. Set an empty array to clear the geolocation.

locationId

• type: string
• optional: true
• pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
  The location id is the identity of the actual device that will be associated with this record. This can be used instead of the shortCode field when registering an on-prem device. The location id does not change so this can be a simpler approach for large scale system administration.

preloadSoftwareVersion

• type: string
• optional: true
• maxLength: 255
  A version string.

shortCode

• type: string
• optional: true
• minLength: 8
• maxLength: 8
  The short code from a device's web user interface, used to on-board the device. The short code expires quickly, so it should be used immediately after it is generated. Read On-board fleet devices to learn more about on-boarding devices.

siteName

• type: string
• optional: true
• pattern: ^a-z0-9?$
  The name of the glossary:site where the device is located.