13.4 Get-DRADynamicDistributionGroupPreview

Synopsis

Previews the objects in a container that would match the conditions of a dynamic distribution group.

Syntax

Get-DRADynamicDistributionGroupPreview [-Attributes <String[]>] -Properties <Hashtable> -Domain <String> [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Get-DRADynamicDistributionGroupPreview cmdlet returns the objects that would match the conditions of a dynamic distribution group. The response contains the list of objects that are in the specified filter of the target container. You can specify the target container using either the recipientContainer or the distinguishedName attribute.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

Attributes [<String[]>]

An array of attributes to retrieve values for. If this parameter is missing, a default list of properties is returned.

false

named

 

true (ByPropertyName)

false

PowersForOperations [<String[]>]

An array of DRA operation names for which you want the server to return read/write permission information.This parameter is typically used by a UI-based client to hide or disable elements the calling user doesn't have powers for. The PowersForOperations parameter is applicable only if you have specified the Identifier parameter.

false

named

 

true (ByPropertyName)

false

VisiblePropertiesOnly [<SwitchParameter>]

A flag to indicate whether DRA should return only properties the caller has powers to view. By default, DRA will return an error if the caller requests a property that they do not have powers to view. By specifying this flag, DRA is instructed to not return an error and instead just not return a value for such properties.

false

named

 

false

false

Identifier <String>

The name or distinguished name of an existing Active Directory object. When the name is specified, an additional call to the DRA Server is needed to obtain the distinguished name for the object.

true

named

 

true (ByPropertyName)

false

Domain <String>

The domain of the object in fqdn format. For example: mydomain.corp

true

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA REST Service. The requested DRA operation will execute on this server. If the parameter is not specified, the value defaults to 'localhost'.

false

named

 

true (ByPropertyName)

false

DRARestPort [<Int32>]

The port where the DRA REST Service listens for requests. If the parameter is not specified, the value defaults to 8755.

false

named

8755

true (ByPropertyName)

false

IgnoreCertificateErrors [<SwitchParameter>]

Allows the request to bypass any SSL certificate errors, such as the InvalidOperation error that occurs when the REST Service is bound to a self-signed certificate.

false

named

 

false

false

Force [<SwitchParameter>]

Suppresses any request for user input and supplies a 'yes' response. For example: -Force with a delete request will perform the delete without presenting the confirmation request to the user.

false

named

 

false

false

Timeout [<Int32>]

The number of seconds to wait before the request to the DRA REST server times out. To specify an infinite timeout, you can set this parameter to -1.

false

named

100 seconds

true (ByPropertyName)

false

<CommonParameters>

Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see About CommonParameters.

 

 

 

 

 

NOTE:For more information, type "Get-Help Get-DRADynamicDistributionGroupPreview -detailed". For technical information, type "Get-Help Get-DRADynamicDistributionGroupPreview -full".

Example 13-8 1

PS C:\>Get-DRADynamicDistributionGroupPreview -Domain MyDomain.corp -Properties @{description="some information"; recipientContainer="OU=Tax,DC=MyDomain,DC=corp";ConditionalCustomAttribute1="value1","value2";ConditionalStateOrProvince="TX","OR";ConditionalDepartment="Accounting";ConditionalCompany="ACME"}

This example will return a list of objects that would match the dynamic distribution group conditions in the Tax OU in MyDomain.corp. The group members will each have all of the criteria listed for ConditionalCustomAttribute1, ConditionalStateOrProvince, ConditionalDepartment and ConditionalCompan