[Index]

Model: data/LyncDefaults

Microsoft Defaults

The Lync/Microsoft Default settings provide a mechanism for ensuring that the Quick Add Subscriber and Subscriber Management automation templates apply the settings that are appropriate for a specific environment (i.e. site or customer). When adding a subscriber using the Quick Add Subscriber automation template the Quick Add Groups are applied once the Lync/Microsoft details are applied.

More particularly the settings that are applied to Microsoft Lync / Skype for Business users can be defined:

(1) Overridden: When a policy is defined in the Lync/Microsoft Defaults it will be overwritten if defined in an instance at site level or in the Quick add groups.

NOTE: This mechanism will be referred to as the policy applicable to the user or just applicable policy.

Default Lync / Skype for Business Polices

VOSS can be used to configure the following Lync/Skype for Business policies based on the business hierarchy of the user.

Enterprise Voice Configuration:

Advanced Policies:

Default Voicemail Policies

Quick Add Subscriber operations with the Voicemail option selected operate as follows:

NOTE: The user will only see Voicemail in the Quick Add Subscriber user interface and the defaults will define whether Unity Connect mailbox or Exchange UM is provisioned.

The default Exchange UM Mailbox Policy used when enabling Exchange UM can be specified unless overridden by Quick Add Groups.

Default Online Skype for Business Polices

VOSS can be used to configure the following online Skype for Business policies based on the business hierarchy of the user.

Currently Policies:

Default Online Voicemail Policies

The default Online Exchange UM Mailbox Policy used when enabling Online Exchange UM can be specified unless overridden by Quick Add Groups.

Selecting Microsoft Licenses

In order to allocate the correct Office 365 features applicable in the country that the user is consuming the license, specify the default Usage Location (country) used for the site. This is mandatory for sites where Office 365 is deployed.

VOSS Number Inventory in a MS environment

When a DID (any E164 number i.e. starting with a "+") is used, the last (X) numbers (as specified by "Extension Length" in MS Site Defaults) will determine the extension. Example: When selecting a DID of +27215252020 with an Extension Length set to 4 digits, the user will be allocated an extension of 2020.

If the DID and extension exists in the VOSS-4-UC Number Inventory, both the DID and the extension will be marked as "used" and "unavailable" at the site hierarchy where the subscriber exists. Example: The VOSS-4-UC Number Inventory contains a DID of +27215252020 at the Cape Town site and an extension at the Reading site 2020. When a user at Cape Town Site is provisioned with with a DID of +27215252020, VOSS-4-UC will only mark the DID in Cape Town as "used" and "unavailable", since extension 2020 does not exist at Cape Town site. The extension 2020 at Reading site remains available and unused.

When DIDs and/or Extension Numbers are specified (for services or when modifying existing services) in the format of a Skype for Business Line URI; or a separate phone number or extension is specified in Quick Add Subscriber, the corresponding DID and extension in the VOSS-4-UC Number Inventory will be updated accordingly.

Extension Length

The VOSS-4-UC Number Inventory can be used to manage Direct Inward Dialling Numbers (DIDs) and/or Extension Numbers.

Numbers in the Number Inventory that start with a '+' are considered DIDs.

Features that make use of the VOSS-4-UC Number Inventory selector can derive the Extension at the selected site from the selected DID using the Extension Length configured by the Microsoft Defaults of the site.

VOSS-4-UC supports Extension Lengths between 3 to 7 digits.

Using Extension Length in Microsoft Defaults to derive Extension Numbers from DID numbers

When editing Microsoft Lync / Skype for Business LineURI of users or other features such as Conference Dial-in Access Numbers the Extension Length setting in Microsoft defaults in is handled as follows:

Updating the VOSS-4-UC Number Inventory

When DIDs and/or Extension Numbers selected as the LineURI, Phone Number or Extension are stored in the VOSS-4-UC Number Inventory the status (used and/or available) of the Extension Numbers and/or DID numbers will be updated accordingly.

Hosted Migration Service URL

To determine the Hosted Migration Service URL for your Office 365 tenant:

Model Details

Title Description Details
Name *
  • Field Name: name
  • Type: String
Default Audio Video Option
  • Field Name: audio_video_disabled
  • Type: String
Default Enterprise Voice Option
  • Field Name: enterprise_voice_enabled
  • Type: String
Default Remote Call Control Telephony Option
  • Field Name: remote_call_control_telephony_enabled
  • Type: String
SfB Hosted Migration Override Url This value will populate the OU field
  • Field Name: HostedMigrationOverrideUrl
  • Type: String
SfB Target This value will populate the OU field
  • Field Name: Target
  • Type: String
Exchange Remote Host Name This value will populate the OU field
  • Field Name: RemoteHostName
  • Type: String
Exchange Target Delivery Domain This value will populate the OU field
  • Field Name: TargetDeliveryDomain
  • Type: String
Exchange Remote Target Database
  • Field Name: RemoteTargetDatabase
  • Type: String
Default Telephony
  • Field Name: telephony
  • Type: String
  • Choices: ["Remote Call Control Only", "Remote Call Control", "Enterprise Voice", "Audio/Video Disabled", "PC-to-PC"]
Default Registrar Pool
  • Field Name: registrarpool
  • Type: String
Default Dial Plan
  • Field Name: dialplan
  • Type: String
Default Voice Policy
  • Field Name: voice_policy
  • Type: String
Default Conferencing policy
  • Field Name: conferencing_policy
  • Type: String
Default Client version policy
  • Field Name: client_version_policy
  • Type: String
PIN policy
  • Field Name: pin_policy
  • Type: String
Default External access policy
  • Field Name: external_access_policy
  • Type: String
Default Archiving policy
  • Field Name: archiving_policy
  • Type: String
Default Location policy
  • Field Name: location_policy
  • Type: String
Default Mobility policy
  • Field Name: mobility_policy
  • Type: String
Default Persistant Chat policy
  • Field Name: persistent_chat_policy
  • Type: String
Default Client policy
  • Field Name: client_policy
  • Type: String
Default Call via work policy
  • Field Name: call_via_work_policy
  • Type: String
Default hosted voicemail policy
  • Field Name: hosted_voicemail_policy
  • Type: String
Default Presence policy
  • Field Name: presence_policy
  • Type: String
Default Third Party Video System policy
  • Field Name: third_party_video_system_policy
  • Type: String
Default User Services policy
  • Field Name: user_services_policy
  • Type: String
Default Voice Routing policy
  • Field Name: voice_routing_policy
  • Type: String
Name of a SIP trunk to SBC
  • Field Name: cucm_to_sbc_trunk
  • Type: String
Name of a SIP trunk to Lync
  • Field Name: cucm_to_lync_trunk
  • Type: String
Enable provisioning of a RoutePattern for each SfB Subscriber
  • Field Name: enable_per_subscriber_route_pattern
  • Type: Boolean
Name of a SIP trunk to Lync
  • Field Name: provision_global_lync_route_pattern
  • Type: Boolean
Collaboration at Work
  • Field Name: collaboration_at_work
  • Type: Boolean
Exchange UM for Voicemail Default: True
  • Field Name: exchange_um_voicemail
  • Type: Boolean
  • Default: True
Microsoft Online Only Deployment Users are provisioned in MS Online as Cloud Users and not migrated from on-premise devices
  • Field Name: ms_online_only_deployment
  • Type: Boolean
Exchange UM Mailbox Policy
  • Field Name: um_mailbox_policy
  • Type: String
Extension Length The number of digits at the end of the DID which is used as an extension Default: 4
  • Field Name: extension_length
  • Type: String
  • Default: 4
  • Choices: ["3", "4", "5", "6", "7"]
Temp OU This value will populate the OU field
  • Field Name: voss_ou
  • Type: String
Usage Location Location used for MS Licensing, set in MS Site Defaults Default: US
  • Field Name: usage_location
  • Type: String
  • Default: US
  • Choices: ["Afghanistan", "Åland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas, The", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire, Saint Eustatius and Saba", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cabo Verde", "Cambodia", "Cameroon", "Canada", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo (DRC)", "Cook Islands", "Costa Rica", "Côte d’Ivoire", "Croatia", "Curaçao", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Islas Malvinas)", "Faroe Islands", "Fiji Islands", "Finland", "France", "French Guiana", "French Polynesia", "French Southern and Antarctic Lands", "Gabon", "Gambia, The", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City State)", "Honduras", "Hong Kong SAR", "Hungary", "Iceland", "India", "Indonesia", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Korea, Republic of", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao SAR", "Macedonia, Former Yugoslav Republic of", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles (Former)", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Authority", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "Saint Barthélemy", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Martin", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "São Tomé and Príncipe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Sudan", "Spain", "Sri Lanka", "Suriname", "Svalbard and Jan Mayen Island", "Swaziland", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Minor Outlying Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Virgin Islands, British", "Virgin Islands, U.S.", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe"]
Office 365 Description of the MS Online infrastructure supported at this site.
  • Field Name: office_365
  • Type: Object
Usage Location Default: US
  • Field Name: office_365.usage_location
  • Type: String
  • Default: US
  • Choices: ["Afghanistan", "Åland Islands", "Albania", "Algeria", "American Samoa", "Andorra", "Angola", "Anguilla", "Antarctica", "Antigua and Barbuda", "Argentina", "Armenia", "Aruba", "Australia", "Austria", "Azerbaijan", "Bahamas, The", "Bahrain", "Bangladesh", "Barbados", "Belarus", "Belgium", "Belize", "Benin", "Bermuda", "Bhutan", "Bolivia", "Bonaire, Saint Eustatius and Saba", "Bosnia and Herzegovina", "Botswana", "Bouvet Island", "Brazil", "British Indian Ocean Territory", "Brunei", "Bulgaria", "Burkina Faso", "Burundi", "Cabo Verde", "Cambodia", "Cameroon", "Canada", "Cayman Islands", "Central African Republic", "Chad", "Chile", "China", "Christmas Island", "Cocos (Keeling) Islands", "Colombia", "Comoros", "Congo", "Congo (DRC)", "Cook Islands", "Costa Rica", "Côte d’Ivoire", "Croatia", "Curaçao", "Cyprus", "Czech Republic", "Denmark", "Djibouti", "Dominica", "Dominican Republic", "Ecuador", "Egypt", "El Salvador", "Equatorial Guinea", "Eritrea", "Estonia", "Ethiopia", "Falkland Islands (Islas Malvinas)", "Faroe Islands", "Fiji Islands", "Finland", "France", "French Guiana", "French Polynesia", "French Southern and Antarctic Lands", "Gabon", "Gambia, The", "Georgia", "Germany", "Ghana", "Gibraltar", "Greece", "Greenland", "Grenada", "Guadeloupe", "Guam", "Guatemala", "Guernsey", "Guinea", "Guinea-Bissau", "Guyana", "Haiti", "Heard Island and McDonald Islands", "Holy See (Vatican City State)", "Honduras", "Hong Kong SAR", "Hungary", "Iceland", "India", "Indonesia", "Iraq", "Ireland", "Isle of Man", "Israel", "Italy", "Jamaica", "Japan", "Jersey", "Jordan", "Kazakhstan", "Kenya", "Kiribati", "Korea, Republic of", "Kuwait", "Kyrgyzstan", "Laos", "Latvia", "Lebanon", "Lesotho", "Liberia", "Libya", "Liechtenstein", "Lithuania", "Luxembourg", "Macao SAR", "Macedonia, Former Yugoslav Republic of", "Madagascar", "Malawi", "Malaysia", "Maldives", "Mali", "Malta", "Marshall Islands", "Martinique", "Mauritania", "Mauritius", "Mayotte", "Mexico", "Micronesia", "Moldova", "Monaco", "Mongolia", "Montenegro", "Montserrat", "Morocco", "Mozambique", "Myanmar", "Namibia", "Nauru", "Nepal", "Netherlands", "Netherlands Antilles (Former)", "New Caledonia", "New Zealand", "Nicaragua", "Niger", "Nigeria", "Niue", "Norfolk Island", "Northern Mariana Islands", "Norway", "Oman", "Pakistan", "Palau", "Palestinian Authority", "Panama", "Papua New Guinea", "Paraguay", "Peru", "Philippines", "Pitcairn Islands", "Poland", "Portugal", "Puerto Rico", "Qatar", "Reunion", "Romania", "Russia", "Rwanda", "Saint Barthélemy", "Saint Helena, Ascension and Tristan da Cunha", "Saint Kitts and Nevis", "Saint Lucia", "Saint Martin", "Saint Pierre and Miquelon", "Saint Vincent and the Grenadines", "Samoa", "San Marino", "São Tomé and Príncipe", "Saudi Arabia", "Senegal", "Serbia", "Seychelles", "Sierra Leone", "Singapore", "Sint Maarten", "Slovakia", "Slovenia", "Solomon Islands", "Somalia", "South Africa", "South Georgia and the South Sandwich Islands", "South Sudan", "Spain", "Sri Lanka", "Suriname", "Svalbard and Jan Mayen Island", "Swaziland", "Sweden", "Switzerland", "Taiwan", "Tajikistan", "Tanzania", "Thailand", "Timor-Leste", "Togo", "Tokelau", "Tonga", "Trinidad and Tobago", "Tunisia", "Turkey", "Turkmenistan", "Turks and Caicos Islands", "Tuvalu", "U.S. Minor Outlying Islands", "Uganda", "Ukraine", "United Arab Emirates", "United Kingdom", "United States", "Uruguay", "Uzbekistan", "Vanuatu", "Venezuela", "Vietnam", "Virgin Islands, British", "Virgin Islands, U.S.", "Wallis and Futuna", "Western Sahara", "Yemen", "Zambia", "Zimbabwe"]
Default Online Broadcast Meeting Policy
  • Field Name: DefaultOnlineBroadcastMeetingPolicy
  • Type: String
Default Online Client Policy
  • Field Name: DefaultOnlineClientPolicy
  • Type: String
Default Online Conferencing Policy
  • Field Name: DefaultOnlineConferencingPolicy
  • Type: String
Default Online External Access Policy
  • Field Name: DefaultOnlineExternalAccessPolicy
  • Type: String
Default Online Graph Policy
  • Field Name: DefaultOnlineGraphPolicy
  • Type: String
Default Online Hosted Voicemail Policy
  • Field Name: DefaultOnlineHostedVoicemailPolicy
  • Type: String
Exchange Online UM Mailbox Policy
  • Field Name: online_um_mailbox_policy
  • Type: String
Caller ID Policy
  • Field Name: caller_id_policy
  • Type: String
IP Phone Policy
  • Field Name: ip_phone_policy
  • Type: String
Exchange Archiving Policy
  • Field Name: exchange_archiving_policy
  • Type: String
API reference for data/LyncDefaults