Get-CsPushNotificationConfiguration
Topic Last Modified: 2012-04-23
Retrieves information about the push notification configuration settings currently in use in your organization. The push notification service (Apple Push Notification Service and Microsoft Lync Server 2010 Push Notification Service) provides a way to send notifications about events such as new instant messages or new voice mail to mobile devices such as iPhones and Windows Phones, even if the Microsoft Lync 2010 application on those devices is currently suspended or running in the background.
Syntax
Get-CsPushNotificationConfiguration [-Identity <XdsIdentity>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]
Get-CsPushNotificationConfiguration [-Filter <String>] [-LocalStore <SwitchParameter>] [-Tenant <Nullable>]
Detailed Description
The Apple Push Notification Service and the Microsoft Lync Server 2010 Push Notification Service enable users running Lync 2010 on their Apple iPhone or Windows Phone to receive notifications about Lync 2010 events even when Lync 2010 is suspended or running in the background. For example, users can receive notice for events such as these:
- Invitations to a new instant messaging session or conference
- New instant messages
- New voice mail
Without the push notification service users would receive these notices only when Lync 2010 was in the foreground and serving as the active application.
Administrators have the ability to enable or disable push notifications for iPhone users and/or Windows Phone users. (By default, push notifications are disabled for both iPhone users and Windows Phone users.) Administrators can enable or disable push notifications at the global scope by using the Set-CsPushNotificationConfiguration cmdlet. They can also create custom push notification settings at the site scope by using the New-CsPushNotificationConfiguration cmdlet.
The Get-CsPushNotificationConfiguration cmdlet provides a way for you to return information about the push notification configuration settings currently in use in your organization.
Who can run this cmdlet: By default, members of the following groups are authorized to run the Get-CsPushNotificationConfiguration cmdlet locally: RTCUniversalServerAdmins.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
Identity |
Optional |
XdsIdentity |
Indicates the unique identifier for the collection of push notification settings you want to return. To refer to the global settings use this syntax: -Identity global To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond Note that you cannot use wildcards when specifying an Identity. If you need to use wildcards, then include the Filter parameter instead. If this parameter is not specified, then Get-CsPushNotificationConfiguration returns a collection of all the push notification configuration settings in use in the organization. |
Tenant |
Optional |
GUID |
This parameter is reserved for use with Microsoft Office 365. |
Filter |
Optional |
String |
Enables you to use wildcard characters in order to return a collection (or collections) of push notification configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:* To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*" |
LocalStore |
Optional |
SwitchParameter |
Retrieves the push notification configuration data from the local replica of the Central Management store rather than from the Central Management store itself. |
Input Types
Get-CsPushNotificationConfiguration does not accept pipelined input.
Return Types
Get-CsPushNotificationConfiguration returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object.
Example
-------------------------- Example 1 --------------------------
Get-CsPushNotificationConfiguration
The preceding command returns information about all the push notification settings configured for use in your organization.
-------------------------- Example 2 --------------------------
Get-CsPushNotificationConfiguration -Identity "site:Redmond"
The command shown in Example 2 returns information about a single collection of push notification settings: the settings configured for the Redmond site.
-------------------------- Example 3 --------------------------
Get-CsPushNotificationConfiguration -Filter "site:*"
In Example 3, the command returns all the push notification settings assigned to the site scope. To do this, the command uses the Filter parameter and the filter value "site:*"; that filter value returns only those settings that have an Identity that begins with the string value "site:".
-------------------------- Example 4 --------------------------
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False}
The preceding command returns all the push notification settings where push notifications for iPhones have been disabled. To do this, the command first uses the Get-CsPushNotificationConfiguration cmdlet to return a collection of all the push notification settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableApplePushNotificationService property is equal to (-eq) False.
-------------------------- Example 5 --------------------------
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False -or $_.EnableMicrosoftPushNotificationService -eq $False}
In Example 5, information is returned for all the push notification settings where either the Apple Push Notification Service and/or the Lync Server 2010 Push Notification Service have been disabled. To carry out this task, the command first uses the Get-CsPushNotificationConfiguration cmdlet in order to return a collection of all the push notification settings currently in use. This collection is then piped to the Where-Object cmdlet, which picks out those settings which meet one (or both) of the following criteria: 1) the EnableApplePushNotificationService property is equal to (-eq) False; 2) the EnableMicrosoftPushNotificationService property is equal to False. The –or operator tells Where-Object to look for settings that meet either criteria. To restrict the returned data to settings where both services have been disabled, use the –and operator instead:
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService –eq $False –and $_.EnableMicrosoftPushNotificationService –eq $False}