You can add, update, and delete Webex devices in Automate, including collaboration devices, ATA (analog telephone adaptor) devices, MPP (IP desk phone) devices, and Wi-Fi devices.

You can also add Webex devices in the Webex Control Hub and sync in those devices to the correct hierarchy in Automate.

Webex devices are added by their MAC address to either a user or to a new or existing workspace. In Automate, devices can be added and updated via the Webex App Devices management page (described in this topic) or via Webex App Quick Add Device.

Device

The Device tab/panel displays read-only device details, such as the MAC address (device name) for a particular device.

When adding a device, you'll choose the product (device type), and define whether to associate the device with a workspace or a person. When choosing a device, configuration settings relevant to the device type become available in Advanced Configuration.

Note

A device can be associated either with a workspace or with a person (Webex user), but not with both.

A device associated with a person is defined as a personal device. The Person column in the Webex Devices summary list view displays the person ID (converted to an email address) when a person (rather than a workspace) is associated with a device.

The email address is used to identify the device and the associated user so that both can be moved to the correct hierarchy in a sync.

Advanced Configuration

The Advanced Configuration tab/panel defines the calling parameters for a device. The available configuration settings depend on the device type, for example, MPP, ATA, or Wi-Fi device.

If you wish to apply custom configuration settings to the device, select Define customized device settings to display the additional custom configuration options for the device.

Note

Device-specific custom configuration settings are the same settings that may be defined on the Control Hub for the device type.

The image displays custom configuration settings for a MPP device:

Note

For a MPP device, default PSK (programmable soft key) settings are automatically populated from the Control Hub. All the PSK fields on the form are editable string fields and can be added to or changed, or reset to default values, if required.
For a MPP device, settings in the Customize softkey menus fields comprise default values retrieved from the Control Hub, and are semi-colon separated lists of items that will display for the softkeys. These settings are editable strings that can be customized, or reset to default values, if required.

To reset values for the custom softkey menus or the PSKs, select the applicable Reset to Default Values checkbox. When saving your settings, the default values are retrieved from the Control Hub to replace any custom values.

The image displays custom configuration options for an ATA device:

The image displays custom configuration options for a Wi-Fi device:

Hide custom configuration settings

To hide the custom settings and apply default settings from the Control Hub for the customer and site, deselect Define customized device settings.

Model Details: device/spark/Device

An asterisk * in the title indicates the field is mandatory.
If a field has a default value, it is shown in the Description column.
If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title		Description	Details
Device Details		Group Assigned by FDP	Field Name: Device Details Type: Object
	Name	A friendly name for the device.	Field Name: Device Details.displayName Type: String
	Workspace	The workspace Name associated with the device.	Field Name: Device Details.workspaceName Type: String Target: device/spark/Place Target attr: displayName Format: uri
	Location Name		Field Name: Device Details.locationId Type: String Target: device/spark/Location Target attr: name Format: uri
	Person	The person Email associated with the device.	Field Name: Device Details.personEmail Type: String Target: device/spark/User Target attr: email Format: uri
	Person Id	The person ID associated with the device.	Field Name: Device Details.personId Type: String Target: device/spark/User Target attr: email Format: uri
	Errors	This device has the following issues.	Field Name: Device Details.errorCodes Type: String
	Capabilities	The capabilities of the device.	Field Name: Device Details.capabilities Type: String
	Permissions	The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.	Field Name: Device Details.permissions Type: String
	Connection Status	The connection status of the device.	Field Name: Device Details.connectionStatus Type: String
	Product	The product name.	Field Name: Device Details.product Type: String
	Tags	Tags assigned to the device.	Field Name: Device Details.tags Type: String
	IP Address	The current IP address of the device.	Field Name: Device Details.ip Type: String
	Active Interface	The current network connectivty for the device.	Field Name: Device Details.activeInterface Type: String
	MAC Address	The unique address for the network adapter.	Field Name: Device Details.mac Type: String
	password	Password for third party device.	Field Name: Device Details.password Type: String Is Password: True
	Primary SIP URL	The primary SIP address to dial this device.	Field Name: Device Details.primarySipUrl Type: String
	SIP URLs	All SIP addresses to dial this device.	Field Name: Device Details.sipUrls Type: String
	Serial	Serial number for the device.	Field Name: Device Details.serial Type: String
	Software	The operating system name data and version tag.	Field Name: Device Details.software Type: String
	Upgrade Channel	The upgrade channel the device is assigned to.	Field Name: Device Details.upgradeChannel Type: String
	Created	The date and time that the device was registered, in ISO8601 format.	Field Name: Device Details.created Type: String

Model: device/spark/Device

Devices (Webex App)

Device

Advanced Configuration

Model Details: device/spark/Device