Applies to: Exchange Server 2010 SP2
Topic Last Modified: 2011-10-10
This cmdlet is available only in the cloud-based service.
Use the Get-CASMailboxPlan cmdlet to view information about the Client Access server mailbox plans in the organization.
Syntax
Get-CASMailboxPlan [-Identity
<MailboxPlanIdParameter>] [-Credential <PSCredential>]
[-DomainController <Fqdn>] [-Filter <String>]
[-IgnoreDefaultScope <SwitchParameter>] [-Organization
<OrganizationIdParameter>] [-OrganizationalUnit
<OrganizationalUnitIdParameter>] [-ReadFromDomainController
<SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy
<String>]
|
Detailed Description
The Client Access server mailbox plan controls settings related to client access for the organization, such as POP, IMAP and MAPI client access settings.
Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
|
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.MailboxPlanIdParameter |
The Identity parameter specifies the Client Access server
mailbox plan. Typically, the name of the Client Access server
mailbox plan is the same as the mailbox plan, for example,
You can use any value that uniquely identifies the Client Access server mailbox plan, for example:
|
|
Credential |
Optional |
System.Management.Automation.PSCredential |
The Credential parameter specifies the user name and password for viewing the object. The default is the current user's credentials. This parameter requires the creation and passing of a credential object. This credential object is created by using the Get-Credential cmdlet. For more information, see Get-Credential. |
|
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
This parameter is reserved for internal Microsoft use. |
|
Filter |
Optional |
System.String |
The Filter parameter indicates the OPath filter syntax used to filter the results. |
|
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell session and use the entire forest as the scope. This allows the command to access Active Directory objects that aren't currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions: |
|
Organization |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter |
This parameter is available for multi-tenant deployments. It isn't available for on-premises deployments. For more information about multi-tenant deployments, see Multi-Tenant Support. The Organization parameter specifies the organization in which you'll perform this action. This parameter doesn't accept wildcard characters, and you must use the exact name of the organization. |
|
OrganizationalUnit |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
This parameter is reserved for internal Microsoft use. |
|
ReadFromDomainController |
Optional |
System.Management.Automation.SwitchParameter |
This parameter is reserved for internal Microsoft use. |
|
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter specifies the total number of items to display. |
|
SortBy |
Optional |
System.String |
The SortBy parameter specifies the attribute by which to sort the results. You can sort by only one attribute at a time. You can sort by the following attributes:
The results are sorted in ascending order. |
Input Types
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.
Return Types
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.
Errors
| Error | Description |
|---|---|
|
|
|
Examples
EXAMPLE 1
This example lists all the Client Access server mailbox plans in the organization.
 Copy Code |
|
|---|---|
Get-CASMailboxPlan |
|