10.21 New-DRAOURule

Synopsis

Creates an OU rule in the specified ActiveView.

Syntax

New-DRAOURule -ActiveView <String> -Name <String> [-Exclude <SwitchParameter>] [-ExcludeChildOUs <SwitchParameter>] [-RestrictUsageOnlyAllow <SwitchParameter>] [-RestrictUsageDoNotAllow <SwitchParameter>] [-Comment <String>] [-ObjectsOnly <SwitchParameter>] [-ObjectTypes <String[]>] [-OU <String>] [-OUMatchProperty <String>] [-Domain <String>] [-DomainMatchProperty <String>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The New-DRAOURule cmdlet creates the requested OU rule in the specified ActiveView. You must have the appropriate powers, such as those included in the Manage Security Model role to run this cmdlet.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

ActiveView [<String>]

Name of the ActiveView that is associated with the rule.

true

named

true (ByPropertyName)

false

Name [<String>]

Name of the ActiveView rule to be created.

true

named

true (ByPropertyName)

false

Exclude [<SwitchParameter>]

Specifies whether the ActiveView rule includes or excludes objects. By default, objects are included in the ActiveView rule.

false

named

true (ByPropertyName)

false

ExcludeChildOUs [<SwitchParameter>]

A switch parameter to request that the search exclude child organizational units. By default, child OUs are included.

false

named

true (ByPropertyName)

false

Comment [<String>]

Specifies additional information about the ActiveView rule.

false

named

true (ByPropertyName)

false

ObjectsOnly [<String>]

Specifies whether to include only the matching objects or include both matching objects and OUs. By default, the rule includes both objects and OUs.

false

named

true (ByPropertyName)

false

ObjectTypes [<String[]>]

The type of object that is managed by the rule. This parameter can have the following values:

  • U or User

  • G or Group

  • CP or Computer

  • CT or Contact

  • DDG or DynamicDistributionGroup

  • GMSA or GroupManagedServiceAccount

  • RM or RoomMailbox

  • EM or EquipmentMailbox

  • SM or SharedMailbox

  • OU or OrganizationalUnit

  • All

  • None

You can specify more than one value separated by a comma. If you specify NONE, only OUs are included. By default, the rule includes all types of objects and OUs.

false

named

true (ByPropertyName)

false

Domain [<String>]

The name of the domain to use when searching for objects. You can specify the exact domain name or a wildcard value.

false

named

true (ByPropertyName)

false

DomainMatchProperty [<String>]

The domain property to use when searching for objects. The value can be McsNameValue or McsPath.

false

named

true (ByPropertyName)

false

OU [<String>]

The OU name to use when searching for objects. You can specify the exact OU name or a wildcard value.

false

named

true (ByPropertyName)

false

OUMatchProperty [<String>]

The OU property to use when searching for objects. The value can be McsNameValue or McsPath.

false

named

true (ByPropertyName)

false

RestrictUsageOnlyAllow [<SwitchParameter>]

Enables the objects included in the ActiveView rule to be cloned, moved, or added to other groups. If the value for the RestrictUsageOnlyAllow parameter is true, the cmdlet ignores the value that is specified for the RestrictUsageDoNotAllow parameter. The default value is false.

false

named

true (ByPropertyName)

false

RestrictUsageDoNotAllow [<SwitchParameter>]

Restricts the objects included in the ActiveView rule from being cloned, moved, or added to groups. The default value is false.

false

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 number of the DRA REST Service. This parameter is only used when the DRARestServer parameter is also specified. 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 New-DRAOURule -detailed". For technical information, type "Get-Help New-DRAOURule -full".

Example 10-27 1

PS C:\>New-DRAOURule -Name "DRA OU Rule" -ActiveView "My AV" -OU "*" -Domain "*" -ObjectTypes "User","Group"

This example creates an OU rule named "DRA OU Rule" in an existing ActiveView named "My AV" with a list of user and group objects in any OU, and in any domain.