Get-RDMEntryTags

Synopsis

Retrieve the tags from an entry

Syntax

ID

Get-RDMEntryTags [-ID] <guid> [-ResolveInherited] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObject

Get-RDMEntryTags [-InputObject] <PSConnection> [-ResolveInherited] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Retrieves tags from the specified entry as an array. By default, returns only tags directly assigned to the entry. Use the -ResolveInherited switch to include tags inherited from parent folders. Tag inheritance must be enabled in system or vault settings. Tag inheritance can be enabled on the vault level by modifying the root connection object.

Examples

Example 1

PS C:\> Get-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}"

Get tags from the entry with the specified ID.

Example 2

PS C:\> Get-RDMEntry -Name "MyEntry" | Get-RDMEntryTags

Pipeline usage to get tags from an entry by name.

Example 3

PS C:\> Get-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}" -ResolveInherited

Get tags from the entry including tags inherited from parent folders.

Example 4

PS C:\> $rootEntry = Get-RDMRootEntry
PS C:\> $rootEntry.Root.TagConfigurationMode = 'CustomInherited'
PS C:\> Set-RDMRootEntry $rootEntry
PS C:\> Get-RDMEntryTags -ID "{00000000-0000-0000-0000-000000000000}" -ResolveInherited

Enable tag inheritance in the root connection settings, then retrieve tags including inherited ones.

Parameters

-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 retrieve tags from.

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 retrieve tags from.

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

-ResolveInherited

Include tags inherited from parent folders/groups in the output. Tag inheritance must be enabled in system settings or root connection settings.

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

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

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

Specifies the entry to retrieve tags from.

Outputs

System.String

Tags of entry

Notes

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