Topic Last Modified: 2013-03-07

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 [-Identity <XdsIdentity>] <COMMON PARAMETERS>
Get-CsPresenceProvider [-Filter <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]

Examples

Example 1

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

Copy Code 
Get-CsPresenceProvider

Example 2

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

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

Example 3

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:".

Copy Code 
Get-CsPresenceProvider -Filter "site:*"

Example 4

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".

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

Detailed 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.

To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell command-line interface prompt:

Get-CsAdminRole | Where-Object {$_.Cmdlets –match "Get-CsPresenceProvider"}

Lync Server Control Panel: The functions carried out by the Get-CsPresenceProvider cmdlet are not available in the Lync Server Control Panel.

Parameters

Parameter Required Type Description

Filter

Optional

System.String

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.

Identity

Optional

Microsoft.Rtc.Management.Xds.XdsIdentity

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.

LocalStore

Optional

System.Management.Automation.SwitchParameter

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

Input Types

None. The Get-CsPresenceProvider cmdlet does not accept pipelined input.

Return Types

The Get-CsPresenceProvider cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object.

See Also