[Index]

Model: device/spark/Device

Devices (Webex App)

Full HTML Help

Tip

Use the Action search to navigate Automate

Overview

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.

Note

MPP, ATA, and Wi-FI device types supported in the Control Hub are dynamically retrieved, along with their respective configuration settings, from the Control Hub via the Control Hub's supported device API using Automate's device/spark/SupportedDevices model. This model populates the drop-downs in Automate where you can select a Control Hub supported device.

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 Devices management page (described in this topic) or via Quick Add Webex Device.

Note

Several configuration options are available for each device type. You can manually configure all these options via the the Webex Devices page or auto apply configuration via Quick Add Webex Device.

Related topics

Webex App sync in the Core Feature Guide

Webex App in the Core Feature Guide

Cisco Webex App device settings

Cisco Webex App devices are managed via the Webex Devices page, on the following tabs:

Note

You can toggle the toolbar Tab/Panel icon to display the page layout as either tabs or panels.

Device tab/panel

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.

Lines tab/panel

On the Lines tab/panel, you add lines to a Webex device.

When adding a second line to an existing Webex-supported device (for example, Cisco ATA192), the line type and line weight have the following default values applied:

Note

Default values are only auto-populated on new lines where field values are not explicitly set. This prevents provisioning transactions from failing due to no or incorrect configurations. You can change these values. Existing values on existing lines are not modified.

Advanced Configuration tab/panel

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

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

Title Description Details
Identity Group Assigned by FDP
  • Field Name: Identity
  • Type: Object
Name A friendly name for the device.
  • Field Name: Identity.displayName
  • Type: String
  • MaxLength: 1024
Product The product name.
  • Field Name: Identity.product
  • Type: String
  • MaxLength: 1024
Model The model name - e.g. DMS Cisco 8845
  • Field Name: Identity.model
  • Type: String
  • MaxLength: 1024
Type The product type.
  • Field Name: Identity.type
  • Type: String
  • MaxLength: 1024
Webex Device ID A unique identifier for the device specifically for use with Webex Devices APIs.
  • Field Name: Identity.webexDeviceId
  • Type: String
  • MaxLength: 1024
Calling Device ID A unique identifier for the device specifically for use with Webex Calling APIs.
  • Field Name: Identity.callingDeviceId
  • Type: String
  • MaxLength: 1024
Associations Group Assigned by FDP
  • Field Name: Associations
  • Type: Object
Organization ID The organization associated with the device.
  • Field Name: Associations.orgId
  • Type: String
  • MaxLength: 1024
Workspace Id The workspace ID associated with the device.
  • Field Name: Associations.workspaceId
  • Type: String
  • MaxLength: 1024
Workspace The workspace Name associated with the device.
  • Field Name: Associations.workspaceName
  • Type: String
  • Target: device/spark/Place
  • Target attr: displayName
  • MaxLength: 1024
  • Format: uri
Location Name
  • Field Name: Associations.locationId
  • Type: String
  • Target: device/spark/Location
  • Target attr: name
  • MaxLength: 1024
  • Format: uri
Person Id The person ID associated with the device.
  • Field Name: Associations.personId
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • MaxLength: 1024
  • Format: uri
Person The person Email associated with the device.
  • Field Name: Associations.personEmail
  • Type: String
  • Target: device/spark/User
  • Target attr: email
  • MaxLength: 1024
  • Format: uri
Managed By The entity responsible for managing the device.
  • Field Name: Associations.managedBy
  • Type: String
  • MaxLength: 1024
Network Group Assigned by FDP
  • Field Name: Network
  • Type: Object
IP Address The current IP address of the device.
  • Field Name: Network.ip
  • Type: String
  • MaxLength: 1024
MAC Address The unique address for the network adapter.
  • Field Name: Network.mac
  • Type: String
  • MaxLength: 1024
Active Interface The current network connectivty for the device.
  • Field Name: Network.activeInterface
  • Type: String
  • MaxLength: 1024
SIP & Calling Group Assigned by FDP
  • Field Name: SIP & Calling
  • Type: Object
Primary SIP URL The primary SIP address to dial this device.
  • Field Name: SIP & Calling.primarySipUrl
  • Type: String
  • MaxLength: 1024
SIP URLs All SIP addresses to dial this device.
  • Field Name: SIP & Calling.sipUrls
  • Type: String
  • MaxLength: 1024
Status & Health Group Assigned by FDP
  • Field Name: Status & Health
  • Type: Object
Connection Status The connection status of the device.
  • Field Name: Status & Health.connectionStatus
  • Type: String
  • MaxLength: 1024
Errors This device has the following issues.
  • Field Name: Status & Health.errorCodes
  • Type: String
  • MaxLength: 1024
Capabilities The capabilities of the device.
  • Field Name: Status & Health.capabilities
  • Type: String
  • MaxLength: 1024
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: Status & Health.permissions
  • Type: String
  • MaxLength: 1024
Planned Maintenance The maintenance mode of the device.
  • Field Name: Status & Health.plannedMaintenance
  • Type: String
  • MaxLength: 1024
Lifecycle The lifecycle status of the device.
  • Field Name: Status & Health.lifecycle
  • Type: String
  • MaxLength: 1024
Software & Updates Group Assigned by FDP
  • Field Name: Software & Updates
  • Type: Object
Software The operating system name data and version tag.
  • Field Name: Software & Updates.software
  • Type: String
  • MaxLength: 1024
Software Version Parsed software version (major.minor.patch.build).
  • Field Name: Software & Updates.softwareVersion
  • Type: String
  • MaxLength: 1024
Device Platform The platform the device runs on.
  • Field Name: Software & Updates.devicePlatform
  • Type: String
  • MaxLength: 1024
Upgrade Channel The upgrade channel the device is assigned to.
  • Field Name: Software & Updates.upgradeChannel
  • Type: String
  • MaxLength: 1024
Lifecycle & Timestamps Group Assigned by FDP
  • Field Name: Lifecycle & Timestamps
  • Type: Object
Created The date and time that the device was registered, in ISO8601 format.
  • Field Name: Lifecycle & Timestamps.created
  • Type: String
  • MaxLength: 1024
First Seen Timestamp of the first time the device sent a status post.
  • Field Name: Lifecycle & Timestamps.firstSeen
  • Type: String
  • MaxLength: 1024
Last Seen Timestamp of the last time the device sent a status post.
  • Field Name: Lifecycle & Timestamps.lastSeen
  • Type: String
  • MaxLength: 1024
Inventory Group Assigned by FDP
  • Field Name: Inventory
  • Type: Object
Serial Serial number for the device.
  • Field Name: Inventory.serial
  • Type: String
  • MaxLength: 1024
Tags Tags assigned to the device.
  • Field Name: tags.[n]
  • Type: Array