[Index]

Model: relation/HcsNetworkDeviceListREL

Network Device Lists

Note

References to HCM-F and Shared Data Repository (SDR) are only relevant if installed.

A Network Device List (NDL) is a list of network devices that are assigned to a Site. An NDL can contain one instance each of Cisco HCM-F, Cisco Unified Communications Manager, Cisco Unity Connection, and Cisco WebEx. Only Cisco HCM-F is required.

NDLs can be defined only at the Customer hierarchy level. A customer can have multiple NDLs defined.

NDLs can be defined only by a Provider or Reseller administrator.

The HCM-F device is pre-populated in the NDL and should not be changed.

Shared UC Applications (that is, UC Applications that are defined above the Customer hierarchy level) can be included in an NDL. However, to use that NDL, the customer must be defined as allowing Shared UC Applications.

After an NDL is assigned to any Site, only the following modifications are supported:

An NDL cannot be deleted if it is assigned to any Site.

If a NDL has been created but has not been assigned to a site, deleting it will not remove associated Customer dial plans or the assigned UC-Apps.

Note

Configure a Network Device List

  1. Log in as provider or reseller administrator.
  2. Click Customer Management > Network Device Lists.
  3. Choose a customer on the hierarchy tree where the NDL is to be created.
  4. Click Add.
  5. Enter a name for the NDL, and optionally a desciption.
  6. Click the + next to Cisco Unified CM.
  7. Choose the Cisco Unified Communications Manager instance from the drop-down list.
  8. Optionally, add Cisco Unity Connection and Cisco WebEx instances to the NDL.
  9. Click Save.

Network Device List Selection Rules

If an administrator at a hierarchy has access to more than one Network Device List (NDL), the option to choose a specific hardware group or list may be needed in order to provision a set of devices.

The Rule Model Device Selection Type model provides a solution to this problem and instances of it are a set of rules for views and relations at a hierarchy level. A particular NDL can then be selected from a popup form before the Add form of these model types are shown. In this way, the administrator can then select the specific required NDL.

When an instance of the Rule Model Device Selection Type model is added, the target relation or view is specified and more than one set rules can be added for it - one for each relevant Hierarchy Node Type.

In addition, a Default GUI Rule that is applied to the Relation or View is reflected as the Default value for the Permitted Hierarchy Node Type.

In addition to this behavior, these rules apply:

Network Device Rules at a Site

The following rules apply to Network Device Lists (NDLs), network devices and device models at site hierarchies:

For a site which references a NDL, device models cannot exist at this site if these belong to a network device not referenced in the NDL.

Therefore:

  1. A device model from a device cannot be added to it if it has a NDL referencing a different device.
  2. A NDL cannot be added to it if it has device models that references a different network device than the one referenced in the NDL.

Model Details

Title Description Details
Name * Name of the list of network devices.
  • Field Name: name
  • Type: String
Description The description of the the network device list instance.
  • Field Name: description
  • Type: String
Devices Devices owned by the entity. The entity can be for example a Customer or Service provider.
  • Field Name: devices
  • Type: Object
Active Directory A list of Active Directory references
  • Field Name: activedirectory.[n]
  • Type: Array
Active Directory Hybrid A list of Active Directory Hybrid references
  • Field Name: activedirectoryhybrid.[n]
  • Type: Array
CallManager GUI A list of CallManager GUI references
  • Field Name: GuiCucm.[n]
  • Type: Array
Cisco HCM-F A list of Cisco HCM-F references
  • Field Name: Hcmf.[n]
  • Type: Array
Cisco Unified CM A list of Cisco Unified CM references
  • Field Name: CallManager.[n]
  • Type: Array
Cisco Unified Contact Center Express A list of Cisco Unified Contact Center Express references
  • Field Name: Uccx.[n]
  • Type: Array
Cisco Unity Connection A list of Cisco Unity Connection references
  • Field Name: UnityConnection.[n]
  • Type: Array
Cisco WebEx A list of Cisco WebEx references
  • Field Name: WebEx.[n]
  • Type: Array
Exchange A list of Exchange references
  • Field Name: exchange.[n]
  • Type: Array
Exchange Hybrid A list of Exchange Hybrid references
  • Field Name: exchangehybrid.[n]
  • Type: Array
Exchange Online A list of Exchange Online references
  • Field Name: exchangeonline.[n]
  • Type: Array
IMAP4 A list of IMAP4 references
  • Field Name: Imap.[n]
  • Type: Array
IMP GUI A list of IMP GUI references
  • Field Name: GuiImp.[n]
  • Type: Array
IOS A list of IOS references
  • Field Name: Ios.[n]
  • Type: Array
LDAP A list of LDAP references
  • Field Name: Ldap.[n]
  • Type: Array
Microsoft Online A list of Microsoft Online references
  • Field Name: msonline.[n]
  • Type: Array
PGW A list of PGW references
  • Field Name: Pgw.[n]
  • Type: Array
PowerShell A list of PowerShell references
  • Field Name: powershell.[n]
  • Type: Array
SMTP A list of SMTP references
  • Field Name: Smtp.[n]
  • Type: Array
Service Now A list of Service Now references
  • Field Name: snow.[n]
  • Type: Array
SkypeForBusiness A list of SkypeForBusiness references
  • Field Name: skypeforbusiness.[n]
  • Type: Array
SkypeForBusiness Hybrid A list of SkypeForBusiness Hybrid references
  • Field Name: skypeforbusinesshybrid.[n]
  • Type: Array
SkypeForBusiness Online A list of SkypeForBusiness Online references
  • Field Name: skypeforbusinessonline.[n]
  • Type: Array
Unity Connection GUI A list of Unity Connection GUI references
  • Field Name: GuiCuc.[n]
  • Type: Array
Shadow
  • Field Name: shadow.[n]
  • Type: Array
  • Cardinality: [0..1]
Name *
  • Field Name: shadow.[n].name
  • Type: String
  • MaxLength: 1024
API reference for relation/HcsNetworkDeviceListREL