DeviceBody

metadata

Required

• Object DefaultMetadata
  Resource metadata.
  • displayName (string, Required): A human-readable name for the resource.
  • labels (map from strings to string, Optional): 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 schema

• [any key] (string)

spec

Required

• Object DeviceBodySpec
  Device specification.
  • autoPreloadLatestSoftware (boolean, Optional): Defaults to false.
    Whether the device should automatically preload the latest available software version.
  • availableNetworks (list of objects AvailableNetworkFragment, Required): The list of 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 site.
    • interfaceName (string, Required, pattern: [^\s/]{1,16}): The name of the device interface that will be connected to the network.
    • networkName (string, Required, pattern: ^a-z0-9?$): The name of the network that will be made available to this device.
  • desiredSoftwareVersion (string, Optional): <=255 characters.
    The desired version of software that should be running on the device.
  • geolocation (object GeolocationFragment, Optional): Optional geolocation data for the device.
    • coordinates (list of doubles, Required, 0-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.
    • locationId (string, Optional, 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.
  • preloadSoftwareVersion (string, Optional): <=255 characters.
    A version of the software that should be preloaded on the device.
  • shortCode (string, Optional): 8-8 characters.
    The short code from a device's web user interface, used to on-board the device.
  • siteName (string, Optional, pattern: ^(a-z0-9?)?$): The name of the site where the device is located.