Set-R1DirectoryManager

Set-R1DirectoryManager

SYNOPSIS

Updates the directory manager settings.

SYNTAX

Set-R1DirectoryManager [[-username] <String>] [-password] <SecureString> [[-oldPassword] <SecureString>]
 [[-allowedIps] <String[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates the directory manager settings, including the directory manager password and the list of IP addresses permitted to bind as the directory manager.

The current settings are retrieved before they are updated, and sent back with the supplied values applied over them, so the allowed IP list and the username keep their current values when not specified. 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.

The request body is sent as UTF8 bytes so that the plaintext password cannot be captured by Windows PowerShell parameter binding or module logging.

EXAMPLES

Example 1

Set-R1DirectoryManager -username 'cn=Directory Manager' -password $newSecurePassword -oldPassword $currentSecurePassword

Changes the directory manager password.

Example 2

Set-R1DirectoryManager -username 'cn=Directory Manager' -password $securePassword -allowedIps '10.0.0.1', '10.0.0.2'

Restricts directory manager binds to the specified IP addresses.

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

-allowedIps

The list of IP addresses permitted to bind as the directory manager.

Type: String[]
Parameter Sets: (All)
Aliases:

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

-oldPassword

The existing directory manager password, as a SecureString.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-password

The new directory manager password, as a SecureString.

Type: SecureString
Parameter Sets: (All)
Aliases:

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

-username

The username of the directory manager, e.g. cn=Directory Manager

When not specified, the current username is kept.

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

System.String[]

OUTPUTS

System.Void

NOTES

The directory manager is generally a shared, high privilege account, and a failed password change is disruptive. Test this command against a deployment you can afford to break before using it against one you cannot.

RELATED LINKS