Set-RDMEntryTags

Synopsis

Set an entry's tags

Syntax

ID

Set-RDMEntryTags [-ID] <guid> [-Tags] <string[]> [-PassThru] [-Refresh] [-Set]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

InputObject

Set-RDMEntryTags [-InputObject] <PSConnection> [-Tags] <string[]> [-PassThru] [-Refresh] [-Set]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

Sets the tags for the specified entry from an array. This replaces all existing tags on the entry (inherited tags are not affected). To persist the new tags when using the InputObject parameter set, the switch Set must be used. When using the ID parameter set, the entry is automatically saved. The user must have the right to edit the entry. Tag inheritance can be enabled on the vault level by modifying the root connection object.

Examples

Example 1

PS C:\> Set-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}" -Tags @("Production", "Database", "Critical")

Set tags on an entry using its ID.

Example 2

PS C:\> $entry = Get-RDMEntry -Name 'MyEntry';
PS C:\> Set-RDMEntryTags -InputObject $entry -Tags @("Production", "Database", "Critical") -Set

Set tags on an entry using InputObject and save the changes.

Example 3

PS C:\> Get-RDMEntry -Name "MyEntry" | Set-RDMEntryTags -Tags @("Production", "Database") -PassThru

Pipeline usage with InputObject and PassThru to return the modified entry.

Example 4

PS C:\> Set-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}" -Tags @()

Clear all tags from an entry.

Example 5

PS C:\> $tags = Get-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}"
PS C:\> $tags += "NewTag"
PS C:\> Set-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}" -Tags $tags

Get, modify, and set tags on an entry.

Example 6

PS C:\> Get-RDMEntry -Name "MyEntry" |
Set-RDMEntryTags -Tags @("Production", "Database") -PassThru |
Set-RDMEntryDomain -Domain "MyDomain.com" -PassThru |
Set-RDMEntry

Chain multiple modifications using PassThru and save with Set-RDMEntry.

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: ''

-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: ''

-ID

Specifies the ID of the entry to set tags on. Must be a valid GUID, in the form {00000000-0000-0000-0000-000000000000}.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: ID
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

Specifies the entry to set tags on.

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

-PassThru

Return the modified entry.

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

-Refresh

Refresh entries in the vault. Use Set switch to persist the modification. For modification in bulk, use Update-RDMEntries after the modifications instead of this switch.

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

-Set

Save the modified entry.

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

-Tags

Array of tags to set on the entry. Pass an empty array to clear all tags.

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

-VaultMode

Vault where the command will be applied. Three choices are offered: - Default: Current vault that has been set. - User: Vault specific to the current user. - Global: Global vault of the workspace.

Type: Devolutions.RemoteDesktopManager.VaultMode
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.PSConnection

PSConnection object of the entry to set tags on.

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

Entry with the newly assigned tags is returned when PassThru is used.

Notes

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