Get-MobileDevice

 

Applies to: Exchange Online, Exchange Server 2016

This cmdlet is available in on-premises Exchange Server 2016 and in the cloud-based service. Some parameters and settings may be exclusive to one environment or the other.

Use the Get-MobileDevice cmdlet to get the list of devices in your organization that have active Exchange ActiveSync partnerships.

For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax.

Get-MobileDevice [-Identity <MobileDeviceIdParameter>] <COMMON PARAMETERS>

Get-MobileDevice -Mailbox <MailboxIdParameter> <COMMON PARAMETERS>

COMMON PARAMETERS: [-ActiveSync <SwitchParameter>] [-DomainController <Fqdn>] [-Filter <String>] [-Monitoring <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-OWAforDevices <SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy <String>]

This example returns all the Exchange ActiveSync mobile devices that Tony Smith has used that are associated with his mailbox.

Get-MobileDevice -Identity "TonySmith"

This example returns all the Exchange ActiveSync mobile devices that Tony Smith has used that are associated with his mailbox.

Get-MobileDevice -Mailbox "Redmond\TonySmith"

The Get-MobileDevice cmdlet returns identification, configuration, and status information for each mobile device.

You need to be assigned permissions before you can run this cmdlet. Although all parameters for this cmdlet are listed in this topic, you may not have access to some parameters if they're not included in the permissions assigned to you. To see what permissions you need, see the "Mobile devices user settings" entry in the Clients and mobile devices permissions topic.

 

Parameter Required Type Description

Mailbox

Required

Microsoft.Exchange.Configuration.Tasks.MailboxIdParameter

The Mailbox parameter filters the results by mailbox. You can use any value that uniquely identifies the mailbox.

For example:

  • Name

  • Display name

  • Alias

  • Distinguished name (DN)

  • Canonical DN

  • <domain name>\<account name>

  • Email address

  • GUID

  • LegacyExchangeDN

  • SamAccountName

  • User ID or user principal name (UPN)

ActiveSync

Optional

System.Management.Automation.SwitchParameter

The ActiveSync switch specifies whether to include mobile devices that synchronize with Exchange ActiveSync. You don't need to specify a value with this switch.

DomainController

Optional

Microsoft.Exchange.Data.Fqdn

This parameter is available only in on-premises Exchange 2016.

The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com.

Filter

Optional

System.String

The Filter parameter uses OPATH filter syntax to filter the results by the specified properties and values. The search criteria uses the syntax {<Property> -<Comparison operator> '<Value>'}.

  • <Property> is a filterable property.

  • -<Comparison Operator> is an OPATH comparison operator. For example -eq for equals and -like for string comparison. For more information about comparison operators, see about_Comparison_Operators.

  • <Value> is the property value. Values that aren't integers need to be enclosed in quotation marks ('Value').

You can chain multiple search criteria together using the logical operators -and and -or. For example, {<Criteria1>) -and <Criteria2>} or {(<Criteria1> -and <Criteria2>) -or <Criteria3>}.

You can filter by the following properties:

  • ClientType

  • DeviceAccessControlRule

  • DeviceAccessState

  • DeviceAccessStateReason

  • DeviceActiveSyncVersion

  • DeviceId

  • DeviceImei

  • DeviceMobileOperator

  • DeviceModel

  • DeviceOS

  • DeviceOSLanguage

  • DeviceTelephoneNumber

  • DeviceType

  • DeviceUserAgent

  • FirstSyncTime

  • FriendlyName

  • ProvisioningFlags

  • UserDisplayName

Identity

Optional

Microsoft.Exchange.Configuration.Tasks.MobileDeviceIdParameter

The Identity parameter specifies the mobile device that you want to view. You can use any value that uniquely identifies the mobile device. For example:

  • GUID

  • DeviceIdentity

  • Multi-TenantID

Monitoring

Optional

System.Management.Automation.SwitchParameter

This parameter is available only in on-premises Exchange 2016.

The Monitoring parameter specifies whether mobile devices that are created by monitoring accounts are exposed by the Get-MobileDevice cmdlet. The default value is $false.

OrganizationalUnit

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

The OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example:

  • Name

  • Canonical name

  • Distinguished name (DN)

  • GUID

OWAforDevices

Optional

System.Management.Automation.SwitchParameter

The OWAforDevices switch filters the results by whether OWA for Devices is enabled for the device. You don't need to specify a value with this switch.

ResultSize

Optional

Microsoft.Exchange.Data.Unlimited

The ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000.

SortBy

Optional

System.String

The SortBy parameter specifies the property to sort the results by. You can sort by only one property at a time. The results are sorted in ascending order.

If the default view doesn't include the property you're sorting by, you can append the command with | Format-Table -Auto <Property1>,<Property2>... to create a new view that contains all of the properties that you want to see. Wildcards (*) in the property names are supported.

You can sort by the following properties:

  • DeviceAccessControlRule

  • DeviceAccessState

  • DeviceAccessStateReason

  • DeviceId

  • DeviceImei

  • DeviceMobileOperator

  • DeviceModel

  • DeviceOS

  • DeviceOSLanguage

  • DeviceTelephoneNumber

  • DeviceType

  • DeviceUserAgent

  • FirstSyncTime

  • FriendlyName

  • UserDisplayName

Organization

Optional

Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter

This parameter is reserved for internal Microsoft use.

To see the input types that this cmdlet accepts, see Cmdlet Input and Output Types. If the Input Type field for a cmdlet is blank, the cmdlet doesn’t accept input data.

To see the return types, which are also known as output types, that this cmdlet accepts, see Cmdlet Input and Output Types. If the Output Type field is blank, the cmdlet doesn’t return data.

 
Show: