Get-CsPresenceProvider

Returns information about the presence providers configured for use in the organization. Presence providers represent the PresenceProviders property of a collection of user services configuration settings. This cmdlet was introduced in Lync Server 2013.

Syntax

Get-CsPresenceProvider
   [-Filter <String>]
   [-LocalStore]
   [<CommonParameters>]
Get-CsPresenceProvider
   [[-Identity] <XdsIdentity>]
   [-LocalStore]
   [<CommonParameters>]

Description

The CsPresenceProvider cmdlets are used to manage the PresenceProviders property found in the User Services configuration settings. Among other things, these settings are used to maintain presence information, including a collection of authorized presence providers. That collection is stored in the PresenceProviders property. The Get-CsPresenceProvider cmdlet provides a way for you to return information about the presence providers that have been authorized for use in your organization.

The functions carried out by the Get-CsPresenceProvider cmdlet are not available in the Skype for Business Server Control Panel.

Examples

-------------------------- Example 1 --------------------------

Get-CsPresenceProvider

The command shown in Example 1 returns information about all the presence providers configured for use in your organization.

-------------------------- Example 2 --------------------------

Get-CsPresenceProvider -Identity "global/fabrikam.com"

Example 2 returns information about a single presence provider: the provider with the Identity global/fabrikam.com.

-------------------------- Example 3 --------------------------

Get-CsPresenceProvider -Filter "site:*"

In Example 3, information is returned for all the presence providers configured at the site scope. To do this, the Filter parameter is used along with the filter value "site:*". That filter value limits returned data to presence providers that have an Identity that begins with the string value "site:".

-------------------------- Example 4 --------------------------

Get-CsPresenceProvider | Where-Object {$_.Fqdn -match "fabrikam.com"}

Example 4 returns all the presence providers that have the string value "fabrikam.com" somewhere in their Fqdn property. To carry out this task, the command first uses the Get-CsPresenceProvider cmdlet to return a collection of all the presence providers configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Fqdn property includes (-match) the string value "fabrikam.com".

Optional Parameters

-Filter

Enables you to use wildcards when specifying the Identity of the presence provider (or providers) to be returned. For example, to return all the presence providers configured at the service scope use this filter value:

-Filter "service:*"

You cannot use both the Filter parameter and the Identity parameter in the same command.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-Identity

Unique identifier for the presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the provider has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. For example, to retrieve a single presence provider use syntax similar to this:

-Identity "global/fabrikam.com"

To return all the presence providers for a specific parent, simply specify the scope. For example, this syntax returns all the presence providers configured for the global scope:

-Identity "global"

If neither the Identity nor the Filter parameters are included, then the Get-CsPresenceProvider cmdlet returns information about all your providers.

Type:XdsIdentity
Position:2
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015
-LocalStore

Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Lync Server 2013, Skype for Business Server 2015

Inputs

None

Outputs

Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated