Documentation Download
This documentation can also be download in the 'Downloads' section.

Version History

  • 1.0.0.0:
    • Original version.
  • 1.1.0.0:
    • Details added to log file when exceptions occur in order to better understand why LUMT is not working.
    • Solution upgraded to Visual Studio 2013.
  • 1.2.0.0:
    • Support for "Favorites" group added.
  • 1.3.0.0:
    • Enhanced error logging has been added.
  • 1.4.0.0:
    • Additional error logging has been added.

Help

Description

LUMT tool can be used to manage contacts, ACEs, privacy settings or alert notification settings for Lync Server 2013 users.

Important: The software and source code are provided as samples. They are licensed "as-is." You bear the risk of using it. The contributors give no express warranties, guarantees or conditions. See MS-PL license description for more details.

Usage

LUMT.exe /Mode:<LUMTMode> /UsersFile:<UsersFileName> [/ContactsFile:<ContactsFileName>] [/ContactsGroup:<ContactsGroupName>] [/ACLFile:<ACLFileName>] [/PrivacyPreference:<Privacy>] [/Delete]

Generic Parameter List

Mode Settings to manage with LUMT. Available options are:
Contact: LUMT is used to add or remove contacts for Lync Server users.
ACL: LUMT is used to add or remove ACEs on Lync Server users.
Privacy: LUMT is used to manage privacy settings for Lync Server users.
Alerts: LUMT is used to manage alert notification settings for Lync Server users.
UsersFile Path to the text file containing user SIP addresses beginning with sip:

LUMT can be executed in one mode at a time. It is not possible to run with multiple modes during the same execution cycle.

Contact Mode Parameter List

ContactsFile Path to the text file containing contact SIP addresses beginning with sip: or distribution list addresses beginning with smtp:
ContactsGroup Optional. Name of the group to add contacts. This parameter is ignored when the Delete switch is used. Note: in order to add contacts to the "Favorites" group, specify "Pinned Contacts" as the group name.
Delete Optional. Delete contacts from the user's contact list instead of adding them.

Note: It is not possible to manage contact list if the contact list provider is Unified Contact Store (Exchange Server 2013).

ACL Mode Parameter List

ACLFile Path to the text file containing ACEs for users.
Delete Optional. Delete ACEs from the user's contact list instead of adding them. When the Delete switch is used, the RelationshipLevel parameter is ignored: this means ACES specified are removed no matter what relationship they currently have.

Privacy Mode Parameter List

PrivacyPreference Privacy setting to set for the user. Valid values are Private, Public or Default.

Alerts Mode Parameter List

NotifyAdd Alert display setting to set for the user when someone adds him or her to the cocntact list. Valid values are Yes or No.
NotifyWhenDND Alert display setting to set fgor the user when his or her status is set to DND. Valid values are AllAlerts, AlertsFromWorkgroup or NoAlerts.

Note: Either NotifyAdd, NotifyWhenDND or both parameters can be specified in the Alerts mode.

Examples

LUMT /Mode:Contact /UsersFile:Users.txt /ContactsFile:Contacts.txt
LUMT /Mode:Contact /UsersFile:Users.txt /ContactsFile:Contacts.txt /ContactsGroup:Support
LUMT /Mode:Contact /UsersFile:Users.txt /ContactsFile:Contacts.txt /Delete
LUMT /Mode:ACL /UsersFile:Users.txt /ACLFile:ACL.txt
LUMT /Mode:ACL /UsersFile:Users.txt /ACLFile:ACL.txt /Delete
LUMT /Mode:Privacy /UsersFile:Users.txt /PricacyPreference:Private
LUMT /Mode:Privacy /UsersFile:Users.txt /PricacyPreference:Public
LUMT /Mode:Privacy /UsersFile:Users.txt /PricacyPreference:Default
LUMT /Mode:Alerts /UsersFile:Users.txt /NotifyAdd:No
LUMT /Mode:Alerts /UsersFile:Users.txt /NotifyWhenDND:AlertsFromWorkgroup
LUMT /Mode:Alerts /UsersFile:Users.txt /NotifyAdd:Yes /NotifyWhenDND:NoAlerts

Input File Requirements

UsersFile requirements

Every line must contain only 1 SIP user. Format must be sip:user@domain.com

ContactsFile requirements

Every line must contain only 1 contact. Contact can be one of the following types:
SIP user Format must be sip:user@domain.com
Distribution list Format must be smtp:dl@domain.com

ACLFile requirements

Every line must contain only 1 ACE. ACE input format is ACEType RelationshipLevel UserOrDomain
Each value must be separated by a single white space character.

ACEType value can be:
User ACE applies to a SIP user in the contact list
Domain ACE applies to a SIP domain in the contact list
Company ACE applies to SIP users who are part of the same company
FederatedDomains ACE applies to SIP users who are part of all federated companies
PublicDomains ACE applies to SIP users who are part of public IM domains


RelationshipLevel value can be:
Personal Friend and Family relationship level
Workgroup Workgroup relationship level
Colleagues Colleagues (or Company) relationship level
External External relationship level
Blocked Blocked relationship level


UserOrDomain value can be:
If ACEType is User SIP user to which apply the ACL. Format must be sip:user@domain.com
If ACEType is Domain Domain to which apply the ACL. Format must be domain.com
If ACEType is Company, FederatedDomains or PublicDomains Don't specify any value

Setup

Lync User Management Tool MUST NOT RUN on an existing Lync Server role. It MUST run on an application server used for UCMA applications (the same server could be used for other UCMA applications).

In order for LUMT to work, a trusted application in needed in Lync Server Topology. There are 3 steps that must be done:
  • Create a Lync Server 2013Trusted Application Pool with:
New-CsTrustedApplicationPool -Id <ServerFqdn> -Registrar <RegistrarPoolFqdn> -Site <SiteNumber>
ServerFqdn FQDN of the server that will host LUMT
RegistrarPoolFqdn FQDN of the pool that the Trusted Application Pool is related
SiteNumber Site ID in Lync Server Topology. The Site ID can be retrieved with the Get-CsSite cmdlet
  • Create a Trusted Application with:
New-CsTrustedApplication -ApplicationId LUMT –TrustedApplicationPoolFqdn <ServerFqdn> -Port <PortNumber>
ServerFqdn Same FQDN as used for the New-CsTrustedApplicationPool cmdlet
PortNumber Any non-used port number above 1024, for instance 12345
  • Enable Lync Server Topology with:
Enable-CsTopology

Then, Lync Server 2013 binaries must be installed on the server by using the Lync Server 2013 Deployment Wizard. The following steps must be performed:
  • Install or Update Lync Server System
  • Install Local Configuration Store
  • Request, Install or Assign Certificates
  • Start Services

It is now possible to run LUMT from this server.

Last edited Jan 4, 2016 at 3:31 PM by StefanPlizga, version 20

Comments

No comments yet.