Set-PASSafe

SYNOPSIS

Updates a safe in the Vault

SYNTAX

Gen2-NumberOfDaysRetention (Default)

Set-PASSafe -SafeName <String> [-NewSafeName <String>] [-Description <String>] [-location <String>]
 [-OLACEnabled <Boolean>] [-ManagingCPM <String>] [-NumberOfDaysRetention <Int32>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Gen2-NumberOfVersionsRetention

Set-PASSafe -SafeName <String> [-NewSafeName <String>] [-Description <String>] [-location <String>]
 [-OLACEnabled <Boolean>] [-ManagingCPM <String>] [-NumberOfVersionsRetention <Int32>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Gen1-NumberOfVersionsRetention

Set-PASSafe -SafeName <String> [-NewSafeName <String>] [-Description <String>] [-OLACEnabled <Boolean>]
 [-ManagingCPM <String>] [-NumberOfVersionsRetention <Int32>] [-UseGen1API] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Gen1-NumberOfDaysRetention

Set-PASSafe -SafeName <String> [-NewSafeName <String>] [-Description <String>] [-OLACEnabled <Boolean>]
 [-ManagingCPM <String>] [-NumberOfDaysRetention <Int32>] [-UseGen1API] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Updates a single safe in the Vault. Manage Safe permission is required.

EXAMPLES

EXAMPLE 1

Set-PASSafe -SafeName SAFE -Description "New-Description" -NumberOfVersionsRetention 10

Updates description and version retention on SAFE using Gen2 API

Minimum required version 12.2

EXAMPLE 2

Set-PASSafe -SafeName SAFE -Description "New-Description" -NumberOfDaysRetention 10 -UseGen1API

Updates description and number of days retention on SAFE using Gen1 API

PARAMETERS

-SafeName

The name of the safe to update.

Max Length 28 characters.
Cannot start with a space.
Cannot contain: ‘',’/’,’:’,’*’,’<’,’>’,’”’,’.’ or ‘ ’

Type: String
Parameter Sets: (All)
Aliases:

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

-NewSafeName

A name to rename the safe to

Max Length 28 characters.
Cannot start with a space.
Cannot contain: ‘',’/’,’:’,’*’,’<’,’>’,’”’,’.’ or ‘ ’

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

Updated Description for safe.

Max 100 characters.

Type: String
Parameter Sets: (All)
Aliases:

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

-OLACEnabled

Boolean value, dictating whether or not to enable Object Level Access Control on the safe.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-ManagingCPM

The Name of the CPM user to manage the safe.

Specify “” to prevent CPM management.

Type: String
Parameter Sets: (All)
Aliases:

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

-NumberOfVersionsRetention

The number of retained versions of every password that is stored in the Safe.

Max value = 999 Specify either this parameter or NumberOfDaysRetention.

Type: Int32
Parameter Sets: Gen2-NumberOfVersionsRetention, Gen1-NumberOfVersionsRetention
Aliases:

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

-NumberOfDaysRetention

The number of days for which password versions are saved in the Safe.

Minimum Value: 0
Maximum Value: 3650 Specify either this parameter or NumberOfVersionsRetention

Type: Int32
Parameter Sets: Gen2-NumberOfDaysRetention, Gen1-NumberOfDaysRetention
Aliases:

Required: False
Position: Named
Default value: 0
Accept pipeline input: True (ByPropertyName)
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

-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

-location

The vault location to set for the safe