Topic Last Modified: 2013-08-13
Retrieves information about the push notification configuration settings currently in use in your organization. The push notification service (Apple Push Notification Service and Microsoft 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 Lync application on those devices is currently suspended or running in the background. This cmdlet was introduced in the cumulative update for Lync Server 2010: November 2011.
Syntax
Get-CsPushNotificationConfiguration [-Identity
<XdsIdentity>] <COMMON PARAMETERS>
|
Get-CsPushNotificationConfiguration [-Filter
<String>] <COMMON PARAMETERS>
|
COMMON PARAMETERS: [-LocalStore <SwitchParameter>]
[-Tenant <Guid>]
|
Examples
EXAMPLE 1
Example 1 returns information about all the push notification settings configured for use in your organization.
 Copy Code |
|
|---|---|
Get-CsPushNotificationConfiguration |
|
EXAMPLE 2
The command shown in Example 2 returns information about a single collection of push notification settings: the settings configured for the Redmond site.
| Copy Code |
|
|---|---|
Get-CsPushNotificationConfiguration -Identity "site:Redmond" |
|
EXAMPLE 3
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:".
| Copy Code |
|
|---|---|
Get-CsPushNotificationConfiguration -Filter "site:*" |
|
EXAMPLE 4
Example 4 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.
| Copy Code |
|
|---|---|
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False}
|
|
EXAMPLE 5
In Example 5, information is returned for all the push notification settings where either the Apple Push Notification Service and/or the Microsoft 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}
| Copy Code |
|
|---|---|
Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False -or $_.EnableMicrosoftPushNotificationService -eq $False}
|
|
Detailed Description
The Apple Push Notification Service and the Microsoft Push Notification Service enable users running Lync on their Apple iPhone or Windows Phone to receive notifications about Lync events even when Lync 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 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 |
|---|---|---|---|
|
Filter |
Optional |
System.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*" |
|
Identity |
Optional |
Microsoft.Rtc.Management.Xds.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 the Get-CsPushNotificationConfiguration cmdlet returns a collection of all the push notification configuration settings in use in the organization. |
|
LocalStore |
Optional |
System.Management.Automation.SwitchParameter |
Retrieves the push notification configuration data from the local replica of the Central Management store rather than from the Central Management store itself. |
|
Tenant |
Optional |
System.Guid |
Globally unique identifier (GUID) of the Office 365 tenant account whose push notification configuration settings are to be modified. For example: –Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" You can return the tenant ID for each of your tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID If you are using a remote session of Windows PowerShell and are connected only to Lync Online you do not have to include the Tenant parameter. Instead, the tenant ID will automatically be filled in for you based on your connection information. The Tenant parameter is primarily for use in a hybrid deployment. |
Input Types
The Get-CsPushNotificationConfiguration cmdlet does not accept pipelined input.
Return Types
The Get-CsPushNotificationConfiguration cmdddlet returns instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object.