DeviceBody
object
Resource metadata.
Show 2 propertiesHide 2 properties
displayNamestringRequired
A human-readable name for the resource.
labelsmap from strings to stringOptional
A dictionary of labels associated with the resource.
Maximum number of labels: 32.
Maximum length of a label or value: 256 characters.
Label: alphanumeric, hyphens and underscores.
Value: alphanumeric, hyphens, underscores and spaces.
Show value schemaHide value schema
[any key]string
Device specification.
Show 8 propertiesHide 8 properties
autoPreloadLatestSoftwarebooleanOptionalDefaults to false
Whether the device should automatically preload the latest available software version.
The list of <glossary:network>s 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 propertiesHide 2 properties
interfaceNamestringRequiredpattern: [^\s\/]{1,16}
The name of the <<glossary:device interface>> that will be connected to the network.
networkNamestringRequiredpattern: ^[a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?$
The name of the <glossary:network> that will be made available to this device.
desiredSoftwareVersionstringOptional<=255 characters
The desired version of software that should be running on the device.
Optional geolocation data for the device.
Show 1 propertyHide 1 property
coordinateslist of doublesRequired0-2 items
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.
locationIdstringOptionalpattern: ^[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.preloadSoftwareVersionstringOptional<=255 characters
A version of the software that should be preloaded on the device.
shortCodestringOptional8-8 characters
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.
siteNamestringOptionalpattern: ^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?)?$
The name of the <glossary:site> where the device is located.