[Index]

Model: relation/HcsProviderREL

Providers

Note

In VOSS-4-UC, the provider name is set to the current service provider name in HCM-F (if applicable).

Procedure

  1. Log in to VOSS-4-UC as entadmin at sys.hcs.

  2. Choose Provider Management > Providers.

  3. Click Add.

  4. On the Service Provider Details tab, complete the following fields:

    Field Description
    Name

    The name of the provider. The name is automatically set to the current service provider name in HCM-F (if applicable). You can keep the existing name or overwrite with a more meaningful name. This field is mandatory.

    Note:

    Once you have saved the provider, you cannot change the provider name.

    Note:

    Any spaces in the provider name are converted to underscores in the provider local administrator name and email, if the Create Local Admin check box is selected.
    Description A description of the provider.
    Domain Name The domain of the provider. For example, provider.com. Used when creating the default local administrator so the administrator can log in with an email ID such as ProviderAdmin@provider.com. This field is mandatory.
    Create Local Admin Controls whether a default local administrator is created.
    Cloned Admin Role The ENT default provider role used to create a new role prefixed with the provider name. The created provider role, shown in Default Admin Role field, is assigned to the default local administrator. This field appears only if the Create Local Admin check box is selected.
    Default Admin Role The created provider 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 mandatory field appears only if thr Create Local Admin check box is selected.
    Repeat Default Admin Password Confirm the default local administrator password. This mandatory field appears only if the Create Local Admin check box is selected.

  5. On the Contact Information tab, enter address, email, and phone information as appropriate.

  6. Click Save.

The provider hierarchy node in VOSS-4-UC, and optionally a default provider administrator are created.

Model Details

Title Description Details
Name * Provider's name
  • Field Name: name
  • Type: String
  • MaxLength: 64
  • Pattern: ^[A-Za-z0-9_\- ]+$
Description Provider's Description
  • Field Name: description
  • Type: String
  • MaxLength: 1024
Create Local Admin Indicates whether or not an Admin User should be created Default: true
  • Field Name: create_admin
  • Type: Boolean
  • Default: true
Hierarchy Path Provider entity's hierarchy
  • Field Name: HierarchyPath
  • Type: String
  • MaxLength: 1024
SDR Name SDR Provider Name
  • Field Name: sdrName
  • Type: String
  • MaxLength: 1024
Decouple SDR Name Decouple Provider's SDR Name From Provider's Hierarchy Name Default: false
  • Field Name: decoupleSdrName
  • Type: Boolean
  • Default: false
Domain Name * Provider Domain Name
  • Field Name: directoryDomain
  • Type: String
  • MaxLength: 1024
Misc Data Miscellaneous data used at run-time
  • Field Name: misc_data
  • Type: String
  • MaxLength: 1024
Data Prov
  • Field Name: data_prov
  • Type: Object
id
  • Field Name: data_prov.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: data_prov.name
  • Type: String
  • MaxLength: 64
Description
  • Field Name: data_prov.description
  • Type: String
  • MaxLength: 128
Account ID
  • Field Name: data_prov.accountID
  • Type: String
  • MaxLength: 64
Contact Name
  • Field Name: data_prov.contactName
  • Type: String
  • MaxLength: 128
Contact Address1
  • Field Name: data_prov.contactAddress1
  • Type: String
  • MaxLength: 128
Contact Address2
  • Field Name: data_prov.contactAddress2
  • Type: String
  • MaxLength: 128
Contact City
  • Field Name: data_prov.contactCity
  • Type: String
  • MaxLength: 64
Contact State
  • Field Name: data_prov.contactState
  • Type: String
  • MaxLength: 64
Contact Post Zip
  • Field Name: data_prov.contactPostZip
  • Type: String
  • MaxLength: 32
Contact Country
  • Field Name: data_prov.contactCountry
  • Type: String
  • MaxLength: 32
Contact Phone Number
  • Field Name: data_prov.contactPhoneNumber
  • Type: String
  • MaxLength: 64
Contact Email
  • Field Name: data_prov.contactEmail
  • Type: String
  • MaxLength: 128
Management Network
  • Field Name: data_prov.managementNetwork
  • Type: String
  • Target: data/HCSHcmfManagementNetworkDAT
  • MaxLength: 1024
  • Format: uri
CCDM
  • Field Name: data_prov.cCDM
  • Type: String
  • Target: data/HCSHcmfCCDMDAT
  • MaxLength: 1024
  • Format: uri
CUCDM2
  • Field Name: data_prov.cUCDM2
  • Type: String
  • Target: data/HCSHcmfCUCDM2DAT
  • MaxLength: 1024
  • Format: uri
Directory Domain
  • Field Name: data_prov.directoryDomain
  • Type: String
  • Target: data/HCSHcmfDirectoryDomainDAT
  • MaxLength: 1024
  • Format: uri
Owns CTX
  • Field Name: data_prov.ownsCTX
  • Type: String
  • Target: data/HCSHcmfCTXDAT
  • MaxLength: 1024
  • Format: uri
Monitors Prime Collab
  • Field Name: data_prov.monitorsPrimeCollab
  • Type: String
  • Target: data/HCSHcmfPrimeCollabDAT
  • MaxLength: 1024
  • Format: uri
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: data_user
  • Type: Object
Name
  • Field Name: data_user.name
  • Type: String
Password
  • Field Name: data_user.password
  • Type: String
  • Is Password: True
Data Dd
  • Field Name: data_dd
  • Type: Object
id
  • Field Name: data_dd.id
  • Type: String
  • MaxLength: 1024
Name *
  • Field Name: data_dd.name
  • Type: String
  • MaxLength: 128
Description
  • Field Name: data_dd.description
  • Type: String
  • MaxLength: 128
Active Directory Domain
  • Field Name: data_dd.activeDirectoryDomain
  • Type: String
  • MaxLength: 128
Cloud Connector URL
  • Field Name: data_dd.cloudConnectorURL
  • Type: String
  • MaxLength: 256
Cloud Connector User ID
  • Field Name: data_dd.cloudConnectorUserID
  • Type: String
  • MaxLength: 128
Cloud Connector Initial Password
  • Field Name: data_dd.cloudConnectorInitialPassword
  • Type: String
  • MaxLength: 64
Cloud Connector Admin Email ID
  • Field Name: data_dd.cloudConnectorAdminEmailID
  • Type: String
  • MaxLength: 128
Organization ID
  • Field Name: data_dd.organizationID
  • Type: String
  • MaxLength: 128
Local Admin User ID
  • Field Name: data_dd.localAdminUserID
  • Type: String
  • MaxLength: 128
Local Admin Password
  • Field Name: data_dd.localAdminPassword
  • Type: String
  • Is Password: True
  • MaxLength: 128
Service Account User ID
  • Field Name: data_dd.serviceAccountUserID
  • Type: String
  • MaxLength: 128
Service Account Password
  • Field Name: data_dd.serviceAccountPassword
  • Type: String
  • Is Password: True
  • MaxLength: 128
Admin Account Reset Password URL
  • Field Name: data_dd.adminAccountResetPasswordURL
  • Type: String
  • MaxLength: 128
Type Current LDAP Integration Default: DISABLED
  • Field Name: data_dd.typeCurrentLDAPIntegration
  • Type: String
  • Default: DISABLED
  • MaxLength: 1024
  • Choices: ["DISABLED", "IN_PROGRESS", "ENABLED"]
LDAP Sync Enabled
  • Field Name: data_dd.lDAPSyncEnabled
  • Type: Boolean
Search Base DN
  • Field Name: data_dd.searchBaseDN
  • Type: String
  • MaxLength: 512
Type UID * Default: MAIL
  • Field Name: data_dd.typeUID
  • Type: String
  • Default: MAIL
  • MaxLength: 1024
  • Choices: ["MAIL", "SAMACCOUNT_NAME", "EMPLOYEE_NUMBER", "TELEPHONE_NUMBER", "USER_PRINCIPAL_NAME"]
Org Unit
  • Field Name: data_dd.orgUnit
  • Type: String
  • Target: data/HCSHcmfOrgUnitDAT
  • MaxLength: 1024
  • Format: uri
Credentials
  • Field Name: credentials.[n]
  • Type: Array
Description
  • Field Name: data_dd.credentials.[n].description
  • Type: String
  • MaxLength: 128
Type Credential *
  • Field Name: data_dd.credentials.[n].typeCredential
  • Type: String
  • MaxLength: 1024
  • Choices: ["SNMP_V1", "SNMP_V2", "SNMP_V3", "ADMIN", "PLATFORM", "WMI", "IOS_ENABLE", "HTTP", "CLI", "OPERATOR", "SFTP", "JTAPI"]
User ID
  • Field Name: data_dd.credentials.[n].userID
  • Type: String
  • MaxLength: 256
Password Community String
  • Field Name: data_dd.credentials.[n].password_CommunityString
  • Type: String
  • Is Password: True
  • Store Encrypted: True
  • MaxLength: 512
Type SNMP Access Default: RO
  • Field Name: data_dd.credentials.[n].typeSNMPAccess
  • Type: String
  • Default: RO
  • MaxLength: 1024
  • Choices: ["RO", "RW"]
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
API reference for relation/HcsProviderREL