Option	Description
Site Name	The name of the site. This field is mandatory. Note: Any spaces in the site name are converted to underscores in the site local administrator name and email, if the Create Local Admin check box is selected. Note: A customer location that has been configured in HCM-F and synced into VOSS-4-UC may exist at the sys.hcs hierarchy. If the Site Name you enter matches this customer location, the Migrate from HCM-F to VOSS-4-UC check box is displayed. Click Save to migrate this customer location to a site at the current hierarchy level. The fields are populated with the values that were configured in HCM-F. If you do not want to migrate the customer location, enter a different Site Name. You cannot migrate a customer location to a site if the customer for the site is different than the customer associated with the customer location. When migrating a customer location to a site, an NDL is not selected for the site. You can set the NDL for the site later.
Description	A description for the site.
Extended Name	External clients can use the Extended Name of the site if needed. This field is not used by other components within Cisco HCS. Note: This field exists in the Customer Location record in SDR. When the customer is managed by Cisco Unified Communications Domain Manager 8.1(x), the Extended Name is synced from Cisco Unified Communications Domain Manager 8.1(x) to the Customer Location record in SDR. When the customer is managed by VOSS-4-UC, the Extended Name is synced from VOSS-4-UC to the Customer Location record in SDR.
External ID	External clients can use the External ID of the site if needed. This field is not used by other components within Cisco HCS.
Create Local Admin	Controls whether a default local administrator is created for the site.

Option	Description
Cloned Admin Role	The customer role used to create a new role prefixed with the site name. The created site role, shown in the Default Admin Role field, is assigned to the default local administrator user. This field appears only if the Create Local Admin check box is selected.
Default Admin Role	The created site role that is assigned to the default local administrator. This field is read-only and appears only if the Create Local Admin check box is selected.
Default Admin Password	The password to assign to the default local administrator. This field appears only if the Create Local Admin check box is selected.
Repeat Default Admin Password	Confirm the default local administrator password. This field appears only if the Create Local Admin check box is selected.
Country	The country is used to determine which dial plan to download to the site when the dial plan is configured on the site. This field is mandatory.
Network Device List	Choose the NDL containing the UC applications and WebEx to be used by the site. Once an NDL has been set for the site, it cannot be removed from the site, nor can the NDL be changed to another NDL.
Auto Push Users to CUCM	If enabled, users are automatically pushed to the Cisco Unified Communications Manager that is associated with the NDL. The default is disabled. Note: You can edit the site later, and select this check box for one of the following reasons: To automatically push users at the site to the Cisco Unified Communications Manager. To perform an Auto User Push when an NDL is added to the site. To perform an Auto User Push when a Cisco Unified Communications Manager is associated with an NDL.

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

Site Name *

Field Name: name
Type: String
MaxLength: 64
Pattern: ^[\w\ -]+$

Site ID

Field Name: SiteID
Type: String

Description

Field Name: Description
Type: String

Network Device List Reference

Field Name: ndlr
Type: String
Target: data/NetworkDeviceList
Format: uri

Address Line 1

Field Name: Address1
Type: String

Address Line 2

Field Name: Address2
Type: String

Address Line 3

Field Name: Address3
Type: String

Internal ID

Default: "Auto-generated value"

Field Name: InternalSiteID
Type: String
Default: "Auto-generated value"

Country

Field Name: Country
Type: String
Target: data/Countries
Target attr: country_name
Format: uri

Hcs Site

Field Name: hcsSite
Type: Object

streetAddress3

Field Name: hcsSite.streetAddress3
Type: ["String", "Null"]

streetAddress2

Field Name: hcsSite.streetAddress2
Type: ["String", "Null"]

streetAddress1

Field Name: hcsSite.streetAddress1
Type: ["String", "Null"]

isDefaultLocation

Field Name: hcsSite.isDefaultLocation
Type: ["Boolean", "Null"]

description

Field Name: hcsSite.description
Type: ["String", "Null"]

extendedName

Field Name: hcsSite.extendedName
Type: ["String", "Null"]

externalID

Field Name: hcsSite.externalID
Type: ["String", "Null"]

cdmUpdateTimestamp

Field Name: hcsSite.cdmUpdateTimestamp
Type: ["String", "Null"]

shortName *

Field Name: hcsSite.shortName
Type: String

bkCustomer_shortName

Field Name: hcsSite.bkCustomer_shortName
Type: ["String", "Null"]

Field Name: hcsSite.id
Type: ["String", "Null"]

isDeletable

Field Name: hcsSite.isDeletable
Type: ["Boolean", "Null"]

customer *

Field Name: hcsSite.customer
Type: String
Target: device/hcmf/Customer
Format: uri

city

Field Name: hcsSite.city
Type: ["String", "Null"]

country

Field Name: hcsSite.country
Type: ["String", "Null"]

state

Field Name: hcsSite.state
Type: ["String", "Null"]

isModifiable

Field Name: hcsSite.isModifiable
Type: ["Boolean", "Null"]

siteLocationCode

Field Name: hcsSite.siteLocationCode
Type: ["String", "Null"]

postalCode

Field Name: hcsSite.postalCode
Type: ["String", "Null"]

type *

Default: CustomerLocation

Field Name: hcsSite.type
Type: String
Default: CustomerLocation

syncTimestamp

Field Name: hcsSite.syncTimestamp
Type: ["String", "Null"]

Site Ndlr

Field Name: siteNdlr
Type: Object

Name *

Field Name: siteNdlr.name
Type: String
MaxLength: 1024

Reference

Field Name: siteNdlr.reference
Type: String
Target: data/NetworkDeviceList
MaxLength: 1024
Format: uri

Data User

Field Name: data_user
Type: Object

Name

Field Name: data_user.name
Type: String

Password

Field Name: data_user.password
Type: String
Is Password: True

Hcs Role

Field Name: hcs_role
Type: Object

Name

Field Name: hcs_role.name
Type: String

Role *

The role selector.

Field Name: hcs_role.clonedRole
Type: String
Choices: [" "]

Role *

The role selector.

Field Name: hcs_role.role
Type: String
Choices: [" "]

Data User

Field Name: dataUser
Type: Object

User Name *

The username corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.

Field Name: dataUser.username
Type: String

Email Address

The email address corresponding to the the Username in Cisco Unified Communications Manager and Cisco Unity Connection server.

Field Name: dataUser.email
Type: String

First Name

The first name corresponding to the user first name in Cisco Unified Communications Manager and Cisco Unity Connection server.

Field Name: dataUser.first_name
Type: String

Last Name

The last name corresponding to user last name in Cisco Unified Communications Manager and Cisco Unity Connection server.

Field Name: dataUser.last_name
Type: String

Password

The password corresponding to the user password in Cisco Unified Communications Manager. The password is hidden.

Field Name: dataUser.password
Type: String
Is Password: True
Store Encrypted: True
Pattern: .{8,}

Role *

The role to which the user belongs. See: Role.

Field Name: dataUser.role
Type: String
Target: data/Role
Target attr: name
Format: uri

Language

The preferred language for this user. Default: en-us

Field Name: dataUser.language
Type: String
Target: data/Language
Target attr: lcid
Default: en-us
Format: uri

Set by Default Language

Indicate if the user's language is set by language default in the hierarchy.

Field Name: dataUser.set_language
Type: Boolean

Account Information

Additional account information for the given user.

Field Name: account_information
Type: Object

Change Password on Next Login

Indicates if the user must be forced to change their password the next time that login.

Field Name: dataUser.account_information.change_password_on_login
Type: Boolean

Locked

Indicates if the account has been locked to prevent the user from logging in.

Field Name: dataUser.account_information.locked
Type: Boolean

Disabled

Indicates if the account has been disabled to prevent the user from logging in until an administrator enables the account again.

Field Name: dataUser.account_information.disabled
Type: Boolean

Reason for Disabled

A description of why the account is disabled.

Field Name: dataUser.account_information.reason_for_disabled
Type: String

Credential Policy

Specifies the policy with the rules used to govern this user's credentials.

Field Name: dataUser.account_information.credential_policy
Type: String
Target: data/CredentialPolicy
Target attr: name
Format: uri

Time Locked Due to Failed Login Attempts

The time when the user account was locked as result of the number of failed login attempts exceeding the permitted thresholds.

Field Name: dataUser.account_information.failed_login_lock_date
Type: String
Format: date-time

Time of Last Password Change

The time when the password was last changed.

Field Name: dataUser.account_information.password_last_change_time
Type: String
Format: date-time

Time of Last Password Change By User

The time when the password was last changed by the user.

Field Name: dataUser.account_information.password_last_change_time_by_user
Type: String
Format: date-time

Time of Last Successful Login

The time the user last logged in successfully.

Field Name: dataUser.account_information.last_login_time
Type: String
Format: date-time

Number of Failed Login Attempts Since Last Successful Login

The total number of failed login attempts since last successful login. Default: 0

Field Name: dataUser.account_information.num_of_failed_login_attempts
Type: Integer
Default: 0

Security Questions

Field Name: security_questions.[n]
Type: Array

Question *

Field Name: dataUser.account_information.security_questions.[n].question
Type: String
MaxLength: 128

Answer *

Field Name: dataUser.account_information.security_questions.[n].answer
Type: String
MaxLength: 128

Used Passwords

List of passwords that have been used by user.

Field Name: used_passwords.[n]
Type: Array

Password

Used password

Field Name: dataUser.account_information.used_passwords.[n].password
Type: String

Time Created

Time when password was created.

Field Name: dataUser.account_information.used_passwords.[n].time_created
Type: String

Hcs Site Dat

Field Name: hcsSiteDAT
Type: Object

Name *

Site's name

Field Name: hcsSiteDAT.name
Type: String
MaxLength: 1024
Pattern: ^[A-Za-z0-9_\- ]+$

Create Local Admin

Indicates whether or not an Admin User should be created Default: true

Field Name: hcsSiteDAT.create_admin
Type: Boolean
Default: true

Push Users to CUCM

Indicates whether or not all of Users at Site level are pushed to CUCM Default: false

Field Name: hcsSiteDAT.push_cucm
Type: Boolean
Default: false

Hierarchy Path

Site's entity's hierarchy

Field Name: hcsSiteDAT.HierarchyPath
Type: String
MaxLength: 1024

Migrate from HCM-F to CUCDM

Migrate HCM-F Models to CUCDM Models Default: false

Field Name: hcsSiteDAT.migrate
Type: Boolean
Default: false

Misc Data

Miscellaneous data used at run-time

Field Name: hcsSiteDAT.misc_data
Type: String
MaxLength: 1024

Model: relation/HcsSiteREL

Sites

Model Details