Set-R1AttributeEncryption

Set-R1AttributeEncryption

SYNOPSIS

Updates the attribute encryption settings.

SYNTAX

Set-R1AttributeEncryption [[-encryptKeyInUse] <Boolean>] [[-currentHdapCipher] <String>]
 [[-currentLdifzCipher] <String>] [[-secureLdifExport] <Boolean>] [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Updates the attribute encryption settings.

The current settings are retrieved before they are updated, and sent back with the supplied values applied over them, so a setting left unspecified keeps its current value. The command therefore issues a GET followed by a PUT, and the account needs permission to read the settings as well as to change them.

hdapAttrKeyExists, ldifzKeyExists and availableCiphers report state the API maintains and are not sent back.

EXAMPLES

Example 1

Set-R1AttributeEncryption -secureLdifExport $true

Encrypts LDIF exports, leaving every other setting 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

-currentHdapCipher

The cipher currently used for HDAP attribute encryption.

Type: String
Parameter Sets: (All)
Aliases:

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

-currentLdifzCipher

The cipher currently used for compressed LDIF encryption.

Type: String
Parameter Sets: (All)
Aliases:

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

-encryptKeyInUse

Whether an encryption key is in use.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-secureLdifExport

Whether LDIF exports are encrypted.

Type: Boolean
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
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.Boolean

System.String

OUTPUTS

System.Void

NOTES

Changing attribute encryption risks making already encrypted attributes unreadable.

RELATED LINKS