LYNC Configuration Syntax

This configuration contains the settings for Microsoft Skype for Business and Lync monitoring.

SUBSYS LYNC

ADD SITEGROUP (<site-group>, version={2013|2015|2019}[, wmiprotocol=winrm])

DEFINE SQL_PROFILE (<site-group>:LyncSql, url=<url>[, Auth={SQL|Windows}])
DEFINE LDAP_PROFILE (<site-group>, ip=<ip-address>, basedn=<basedn>[, port=<port_number>][, filter=<filterdn>][, mode={BASIC|SSL}])
DEFINE LDAP_PROFILE (Pool:<site-group>, ip=<ip-address>, pooldn=<pooldn>[, port=<port-number>][, filter=<filterdn>][, mode={BASIC|SSL}])
DEFINE SDN_PROFILE (<site-group>, "url=<web-service-address>")
DEFINE SFB_DOMAINS (domains=<domain>[| <domain>]..., site=<site-name>)

ADD SERVER (<server-name>, ip=<ip-address>, type=<type>[, pool=<pool-fqdn>][, branch=<branch-site-name>])

MAP POOL (<pool-fqdn>, site=<site-name>, sitegroup=<site-group>[, customer=<customer-name>])
MAP SQL (<site-name>, sqlgroup=<site-name-with-sql-database>[, dbnode=\<database-server-name>])

Syntax Elements

ADD SITEGROUP

<site-group>

Name of the Skype/Lync Site Group that contains the servers to be monitored.

version={2013|2015|2019}

Skype for Business version number, either: 2013, 2015 or 2019.

wmiprotocol=winrm

This statement is added when monitoring remote servers in a NATed environment. Such monitoring requires Windows Remote Management (WinRM). 

For details see NAT Configuration for Skype for Business.

DEFINE SQL_PROFILE

<site-group>:LyncSql

Name of the Skype/Lync Site Group followed with the SQL profile name. This must match the PASSWORDS Configuration entry and the SQL profile name must end with ':LyncSql'.

url=<url>

See the SQL URL Syntax for details.

Auth={SQL|Windows}

Optional parameter to specify the authentication type to be used to connect to the SQL Database, Windows or SQL. By omitting this parameter the default of SQL will be applied.

If SQL credentials are required, then the credentials must be stored in the PASSWORDS Configuration, using the entry <site-group>:LyncSQL, see PASSWORDS Configuration for Skype for Business.

If Windows credentials are required, the credentials are obtained by the owner account of the Prognosis service.

DEFINE LDAP_PROFILE

Two LDAP profiles are available for each Skype/Lync site. One is for 'users' and the second one is for 'pools'. The 'pools' profile is defined with the 'Pool:' prefix on the <site-group> parameter and allows a Pool DN (pooldn=) to be specified which can be different to the User or Base DN.

Pool:

Prefix to <site_group> used only in the pooldn configuration statement.

<site-group>

Name of the Skype Site Group. This must match the LDAP PASSWORDS Configuration for Skype for Business entry.

ip=<ip-address>

IP address to the LDAP server.

basedn=<basedn>

Value of rootDomainNamingContext from RootDSE properties.

pooldn=<pooldn>

The PoolDN identifies the location of pools in an active directory and is normally represented by the value of the configurationNamingContext field of the RootDSE properties,
e.g. CN=Configuration, DC=umail, DC=local

port=<port-number>

Port number used by the AD/LDAP server.

filter=<filterdn>

LDAP search filter. If not assigned it will default to using: (msRTCSIP-UserEnabled=TRUE)

mode={BASIC|SSL}

Authentication type for the LDAP server. The supported types are:

- Basic, this is also the default if mode is not assigned.
- SSL.

DEFINE SDN_PROFILE

If the Skype/Lync environment has been set up to send data to the Monitoring Server via the SDN API then this statement will be required to specify to receive the SDN data. See the Skype for Business SDN API Setup.

<site-group>

Name of the Skype/Lync Site Group that contains the servers to be monitored. This is the same as the ADD SITEGROUP statement.

<web-service-address>

URL where the Skype/Lync SDN Manager will send data to.

e.g. "url=http://ServerA:3000/SdnApiReceiver/site"

The server name/ip address can be the same as defined in the LSM or '*' can be used instead of the actual server name.

DEFINE SFB_DOMAINS

(Optional) Use this statement to define the set of 'internal' domain names within the organization. Add a 'DEFINE SFB_DOMAINS' statement for each SfB site being monitored. This is used to define all domains that belong to each local site.

This will cause any calls between the domains specified in the DEFINE SFB_DOMAINS statements as being 'internal', any other calls will be classified as 'Federated' (external). These call classifications will be shown in both the Conversation List filter and the Session Details Display under the 'User Type' field.

<domain>

Provide a list of domains, separated by the pipe '|' character that are contained within the <site-name>

The 'domains=' parameter must precede the 'site=' parameter.

<site-name>

Name of the Skype/Lync Site. This must match 'site=value' from the get-cspool command.

The 'domains=' parameter must precede the 'site=' parameter.

ADD SERVER

<server-name>

Name of the server to be monitored. The server name must begin with a backslash ("\") character.

ip=<ip-address>

The IP address of the server.

type=<type>














Type of server, the supported types are as follows (multiple types can be added separated by the pipe '|' character);

FrontEnd

Call processing

MonitoringSQLServer

SQL backend for the Monitoring server

EnterpriseSQLBackend

Central management store

AVConferencing

Conferencing resources

Archiving

IM & Presence storage

Monitoring

Saving CDRs & QoE

Mediation

Media processing

Director

Pool location, security and authentication

Archiving | Monitoring

Archiving server co-located with Monitoring server

ArchivingSQLServer

IM & Presence storage backend SQL server

FrontEnd | Mediation

Frontend co-located with Mediation server

ActiveDirectory

Authentication/User store

Edge

Remote access

SBAUsed to specify branch sites if they are to be monitored from the main Skype Site, refer to LYNC Configuration for Skype for Business for further details.

pool=<pool-fqdn>

Each server role needs to have a Pool attached to it. In this parameter specify the associated Pool name using its Fully Qualified Domain Name (FQDN).

branch=<branch-site-name>Branch Site name if used with Survivable Branch Appliance (SBA) type.

MAP POOL

This statement is used to map each Skype pool to the associated Skype site and group.

<pool-fqdn>

Fully Qualified Domain Name (FQDN) of the Pool.

<site-name>

Name of the Skype/Lync Site. This must match 'site=value' from the get-cspool command.

<site-group>

Name of the Skype/Lync Site Group.

<customer-name>

(Optional) This field can be completed with a user-defined customer name. It is used for role-based filtering and for grouping purposes. If this field is completed, the details will be visible in the various Displays and will group like customer names together. Only the characters A-z, 0-9, - or _ are permitted.

MAP SQL

This statement is used when multiple Skype sites are sharing a single SQL backend. 

<site-name>

Name of the Skype/Lync Site Group that does not have the SQL Server, and will be mapped to the sqlgroup

sqlgroup=<site-name-with-sql-database>Name of the Skype/Lync Site Group that does have the SQL Server.
dbnode=\<database-server-name>When sharing the SQL database between Monitoring Servers, the dbnode=\ parameter is required in order to configure which server has the data stored. This is usually the Monitoring Server where the SQL data is being collected, i.e. where the DEFINE SQL PROFILE is configured. Note that the '\' needs to be included for the dbnode entry.

Example:

SUBSYS LYNC
ADD SITEGROUP (SYDNEYG, version=2013)

DEFINE SQL_PROFILE(SYDNEYG:LyncSql, url=odbc:LYNCSQL, Auth=Windows)
DEFINE LDAP_PROFILE(SYDNEYG, ip=155.97.181.33, port=523, "basedn=cn=users,dc=umail,dc=local,dc=test", mode=SSL)
DEFINE LDAP_PROFILE(Pool:SYDNEYG, ip=155.97.181.6, port=523, "pooldn=cn=system,dc=umail,dc=local,dc=test", mode=SSL)
DEFINE SDN_PROFILE (SYDNEYG, "url=http://*:3000/SdnApiReceiver/site")

ADD SERVER(\frontend1, ip=10.102.70.150, type=FrontEnd, pool=pool1.lync2013.local)
ADD SERVER(\mediation1, ip=10.102.70.11, type=Mediation, pool=pool2.lync2013.local)
ADD SERVER(\mediation2, ip=10.102.70.21, type=Mediation, pool=pool2.lync2013.local)
ADD SERVER(\director1, ip=10.102.70.13, type=Director, pool=pool3.lync2013.local)
ADD SERVER(\director2, ip=10.102.70.16, type=Director, pool=pool3.lync2013.local)
ADD SERVER(\edge1, ip=10.102.70.14, type=Edge, pool=pool4.lync2013.local)

MAP POOL (pool1.lync2013.local, site=Sydney, sitegroup=SYDNEYNG, customer=Acme)
MAP POOL (pool2.lync2013.local, site=Sydney, sitegroup=SYDNEYNG, customer=Acme)
MAP POOL (pool3.lync2013.local, site=Sydney, sitegroup=SYDNEYNG, customer=Acme)
MAP POOL (pool4.lync2013.local, site=Sydney, sitegroup=SYDNEYNG, customer=Acme)

DEFINE SFB_DOMAINS (domains=xyz.com | london.xyz.com | sydney.xyz.com, site=Sydney)

SQL URL Syntax

"url=odbc:Driver={<odbc-driver-name>}; Server=<server-address>; Database=<db-name>; [Failover_Partner=<mirror-address>] [UID=$username$; PWD=$password$]

Where:

Driver={<odbc-driver-name>}

This should be "ODBC Driver 17 for SQL Server", this driver is provided.

Server=<server-address>

This is the address of the 'Monitoring SQL Server' (known as 'principal server' in a mirrored environment).

The server address is defined in the following syntax: <server-name-ip>\<instance-name>,<port-number>

<server-name-ip>: either the IP Address or DNS Name of the server

<instance-name>: Specify the instance name when a non-default name has been created on the SQL Server.

<port-number>: Specify the port number when a non-default port has been configured on the SQL Server. This will be ignored if instance-name is supplied.

Examples:

  • 10.1.1.2
  • sqlserver
  • 10.1.1.2, 1234
  • sqlserver, 1234
  • sqlserver\myInstance
  • 10.1.1.2\myinstance

Failover_Partner=<mirror-address>

[Optional]

When SQL Mirroring is required, add the ‘Failover Partner’ pointing to the ‘failover partner’ database server. Use the same syntax as Server=<server-address>.

Database=<db-name>

Name of the database to connect to.

Integrated Security=SSPI

or

Trusted_Connection=yes

When "Integrated Security=SSPI' is added the current Windows account credentials will be used for authentication using Security Support Provider Interface.

or

When 'Trusted_Connection=YES' is added the current Windows account credentials will be used for authentication.

UID=$username$; PWD=$password$

If SQL Authentication is needed for access to the SQL Database, add 'UID=$username$; PWD=$password$' literally and this will fetch the SQL Login Credentials from the PASSWORDS Configuration in the 'LyncSql' Entry Name.

Provide feedback on this article