Set-RDMVaultTemplate

Synopsis

Update an existing vault template.

Syntax

__AllParameterSets

Set-RDMVaultTemplate [-InputObject] <PSVaultTemplateInfo> [-Name <string>]
 [-Entries <PSConnection[]>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

Rename a vault template and/or replace its entries. Unlike New-RDMVaultTemplate, the change is always saved immediately.

-Entries accepts unsaved PSConnection objects built with New-RDMEntry (without -Set) and REPLACES the template's entire entry set: any existing entry not represented in -Entries is removed from the template, and -Entries @() clears every entry. Pass the template's own current Entries alongside any new ones to add without removing anything. Any folder referenced by an entry's Group that does not already exist in the template, or in the batch being set, is created automatically.

Requires workspace settings edit permission.

Examples

Example 1

PS C:\> Get-RDMVaultTemplate -Name 'Network Devices' | Set-RDMVaultTemplate -Name 'Network Equipment'

Renames the vault template.

Example 2

PS C:\> $template = Get-RDMVaultTemplate -Name 'Network Devices'
PS C:\> $switch = New-RDMEntry -Name 'Switch1' -Type RDPConfigured -Group 'Network'
PS C:\> $template | Set-RDMVaultTemplate -Entries @($template.Entries + $switch)

Adds a new entry to the already-existing 'Network' folder of the template, keeping every existing entry.

Example 3

PS C:\> $template | Set-RDMVaultTemplate -Entries @()

Removes every entry from the template.

Parameters

-Confirm

Prompts for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- cf
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Entries

Replaces the template's entire entry set, built via New-RDMEntry without -Set. Any existing entry omitted here is removed from the template; pass -Entries @() to clear all. Include the template's own current Entries to keep them. Folders referenced by an entry's Group that don't already exist in the template or the batch are created automatically.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

Vault template to update, obtained from Get-RDMVaultTemplate.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSVaultTemplateInfo
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Name

New name for the vault template.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-WhatIf

Shows what would happen if the cmdlet were to run. The cmdlet does not run.

Type: System.Management.Automation.SwitchParameter
DefaultValue: False
SupportsWildcards: false
Aliases:
- wi
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

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

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSVaultTemplateInfo

Vault template to update, obtained from Get-RDMVaultTemplate or New-RDMVaultTemplate.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSVaultTemplateInfo

Updated vault template object

Notes

For more information, type "Get-Help Set-RDMVaultTemplate -detailed". For technical information, type "Get-Help Set-RDMVaultTemplate -full".