Applies to: Exchange Server 2007 SP3, Exchange Server
2007 SP2, Exchange Server 2007 SP1
Topic Last Modified: 2010-04-27
Use the Get-DynamicDistributionGroup cmdlet to retrieve the settings on an existing dynamic distribution group.
Syntax
Get-DynamicDistributionGroup [-Identity
<DynamicGroupIdParameter>] [-Credential <PSCredential>]
[-DomainController <Fqdn>] [-IgnoreDefaultScope
<SwitchParameter>] [-ManagedBy
<GeneralRecipientIdParameter>] [-OrganizationalUnit
<OrganizationalUnitIdParameter>] [-ReadFromDomainController
<SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy
<String>]
|
Get-DynamicDistributionGroup [-Credential
<PSCredential>] [-DomainController <Fqdn>] [-Filter
<String>] [-IgnoreDefaultScope <SwitchParameter>]
[-ManagedBy <GeneralRecipientIdParameter>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController <SwitchParameter>] [-ResultSize
<Unlimited>] [-SortBy <String>]
|
Get-DynamicDistributionGroup [-Anr <String>]
[-Credential <PSCredential>] [-DomainController <Fqdn>]
[-IgnoreDefaultScope <SwitchParameter>] [-ManagedBy
<GeneralRecipientIdParameter>] [-OrganizationalUnit
<OrganizationalUnitIdParameter>] [-ReadFromDomainController
<SwitchParameter>] [-ResultSize <Unlimited>] [-SortBy
<String>]
|
Parameters
Parameter | Required | Type | Description | ||
---|---|---|---|---|---|
Anr |
Optional |
System.String |
The Anr parameter indicates that the argument will be resolved using ambiguous name resolution (ANR). |
||
Credential |
Optional |
System.Management.Automation.PSCredential |
The Credential parameter indicates the domain and user name of the account used to read Active Directory. |
||
DomainController |
Optional |
Microsoft.Exchange.Data.Fqdn |
To specify the fully qualified domain name (FQDN) of the domain controller that retrieves data from Active Directory, include the DomainController parameter in the command. |
||
Filter |
Optional |
System.String |
The Filter parameter indicates the OPath filter used to filter recipients. For more information about the filterable properties, see Filterable Properties for the -Filter Parameter in Exchange 2007 RTM. |
||
Identity |
Optional |
Microsoft.Exchange.Configuration.Tasks.DynamicGroupIdParameter |
The Identity parameter of the distribution group takes one of the following forms:
|
||
IgnoreDefaultScope |
Optional |
System.Management.Automation.SwitchParameter |
The IgnoreDefaultScope parameter instructs the command to ignore the default recipient scope setting for the Exchange Management Shell and use the entire forest as the scope. This allows the command to access Active Directory objects that are not currently in the default scope. Using the IgnoreDefaultScope parameter introduces the following restrictions:
|
||
ManagedBy |
Optional |
Microsoft.Exchange.Configuration.Tasks.GeneralRecipientIdParameter |
The ManagedBy parameter indicates the DN of the user or contact that manages the group. |
||
OrganizationalUnit |
Optional |
Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter |
The OrganizationalUnit parameter limits results to a specific organizational unit (OU) container. The OrganizationalUnit parameter returns objects from the specified organizational unit (OU) and objects in all child containers. |
||
ReadFromDomainController |
Optional |
System.Management.Automation.SwitchParameter |
The ReadFromDomainController parameter specifies that the user information is read from a domain controller in the user's domain. If you set the recipient scope to include all recipients in the forest, and if you do not use this parameter, it is possible that the user information is read from a global catalog with outdated information. If you use this parameter, multiple reads might be necessary to get the information.
|
||
ResultSize |
Optional |
Microsoft.Exchange.Data.Unlimited |
The ResultSize parameter indicates the maximum number of recipient objects that will be returned. |
||
SortBy |
Optional |
System.String |
The SortBy attribute is used to sort the results. |
Detailed Description
You can use distribution groups to create e-mail distribution lists and security groups to assign permissions to shared resources. Distribution groups can be used only with e-mail applications (such as Microsoft Exchange) to send e-mail messages to collections of users. You can use the Get-DynamicDistributionGroup cmdlet to retrieve the settings on an existing dynamic distribution group in the Active Directory directory service.
To run the Get-DynamicDistributionGroup cmdlet, the account you use must be delegated one of the following:
- Exchange View-Only Administrator role
For more information about permissions, delegating roles, and the rights that are required to administer Exchange Server 2007, see Permission Considerations.
Input Types
Return Types
Errors
Error | Description |
---|---|
|
Exceptions
Exceptions | Description |
---|---|
Example
The following is an example of the Get-DynamicDistributionGroup command. In this example, the Get-DynamicDistributionGroup command retrieves the dynamic distribution group Marketing and pipelines the object to the Format-List command to display the information about the dynamic distribution group.
Copy Code | |
---|---|
Get-DynamicDistributionGroup -Identity "Marketing" | Format-List |