30.1 Add-DRATemporaryGroupAssignment

Synopsis

Creates a new temporary group assignment.

Syntax

Add-DRATemporaryGroupAssignment -Name <String> -GroupIdentifier <String> -UserIdentifiers <String[]> -StartTime <DateTime> -EndTime <DateTime> [-Comment <String>] [-Description <String>] [-Enabled <Boolean>] [-DontDelete <Boolean>] [-DomainController <String>] [-DRARestServer <String>] [-DRARestPort <Int32>] [-IgnoreCertificateErrors <SwitchParameter>] [-Force <SwitchParameter>] [-Timeout <Int32>] [<CommonParameters>]

Description

The Add-DRATemporaryGroupAssignment cmdlet creates a new temporary group assignment. This feature enables users to add members to a group for specific time period. The requesting user must have the Create Temporary Group Assignments power.

Parameters

Attribute / Description

Parameters / Values

Required

Position

Default Value

Accept Pipeline input?

Accept wildcard characters?

Name <String>

The Name parameter specifies the name for the new temporary group assignment.

true

named

 

true (ByPropertyName)

false

GroupIdentifier <String>

The GroupIdentifier parameter specifies the target group for new temporary group assignment. The DistinguishedName value type can be used.For example, CN=NewTGA,DC=MyDomain,DC=corp

true

named

 

true (ByPropertyName)

false

UserIdentifiers <String[]>

The UserIdentifiers parameter specifies the list of temporary members. The Distinguished Name value can be used for each temporary member. For example, CN=NewTGA,DC=MyDomain,DC=corp

true

named

 

true (ByPropertyName)

false

StartTime <DateTime>

The StartTime parameter specifies the start date and time for the new temporary group assignment.

true

named

 

true (ByPropertyName)

false

EndTime <DateTime>

The EndTime parameter specifies the end date and time for the new temporary group assignment.

true

named

 

true (ByPropertyName)

false

Comment [<String>]

The Comment parameter specifies additional information about the new temporary group assignment.

false

named

 

true (ByPropertyName)

false

Description [<String>]

The Description parameter describes the new temporary group assignment.

false

named

 

true (ByPropertyName)

false

Enabled [<Nullable`1>]

The Enabled parameter indicates whether DRA should process the temporary group assignment. When you create a new temporary group assignment, DRA enables the new assignment by default.

false

named

 

true (ByPropertyName)

false

DontDelete [<Nullable`1>]

The DontDelete parameter specifies that after the temporary group assignment expires, DRA saves the temporary group assignment for future use.

false

named

 

true (ByPropertyName)

false

DomainController [<String>]

The DomainController parameter specifies the domain controller for the new temporary group assignment.

false

named

 

true (ByPropertyName)

false

DRARestServer [<String>]

The name of the computer running the DRA REST Service. The requested DRA operation will be sent to the REST Service running on the specified computer. If this parameter is not specified, then the cmdlet will attempt to discover a DRA REST Service to use.

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 DRARestServer parameter is specified but the DRARestPort is not, 8755 will be used as the default REST port.

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 wait time in seconds 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 Add-DRATemporaryGroupAssignment -detailed". For technical information, type "Get-Help Add-DRATemporaryGroupAssignment -full".

Example 30-1 1

PS C:\>Add-DRATemporaryGroupAssignment -Name "MyTGA" -GroupIdentifier "CN=NewTGA,DC=MyDomain,DC=corp" -UserIdentifiers @("CN=NewTGA,DC=MyDomain,DC=corp") -StartTime "14/03/2019 6:10:00 AM" -EndTime "15/03/2019 6:10:00 PM"

This example will create a new temporary group assignment named MyTGA, adding temporary members in the target group for the given time interval. Also, the new temporary group assignment will be enabled if it is not set.

Example 30-2 2

PS C:\>Add-DRATemporaryGroupAssignment -Name "MyTGA" -GroupIdentifier "CN=NewTGA,DC=MyDomain,DC=corp" -UserIdentifiers @("CN=NewTGA,DC=MyDomain,DC=corp") -StartTime "14/03/2019 6:10:00 AM" -EndTime "15/03/2019 6:10:00 PM" -DontDelete $true -Enabled $false

This example will create a new temporary group assignment named MyTGA, with the following configuration: adds temporary members in the target group for the given time interval, enables the DontDelete flag to keep the temporary group assignment for future use, and sets the Enabled flag to false.