Set-R1SpecialGroup

SYNOPSIS

Updates the special groups settings.

SYNTAX

Set-R1SpecialGroup [[-specialUsersGroupDn] <String>] [[-administratorsGroupDn] <String>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Sets the DNs of the groups used as the special users group and the administrators group.

The current settings are retrieved before they are updated, and sent back with the supplied values applied over them, so either group DN can be set without restating the other. The command therefore issues a GET followed by a PUT.

Because the command retrieves the resource before updating it, the account needs permission to read it as well as to change it. A role granted only the update permission fails on the retrieval.

EXAMPLES

Example 1

Set-R1SpecialGroup -specialUsersGroupDn 'ou=special,cn=config' -administratorsGroupDn 'ou=admins,cn=config'

Sets both special group DNs.

Example 2

Set-R1SpecialGroup -administratorsGroupDn 'cn=directory administrators,ou=globalgroups,cn=config'

Sets the administrators group DN, leaving the special users group DN as it is.

PARAMETERS

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-administratorsGroupDn

The DN of the group holding administrators.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

-specialUsersGroupDn

The DN of the group holding special users.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 0
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

System.String

OUTPUTS

System.Void

NOTES