Remove-RDMPlaylistShared

Synopsis

Delete shared playlists.

Syntax

InputObject

Remove-RDMPlaylistShared [-InputObject] <PSConnection[]> [-PassThru] [-Refresh]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Id

Remove-RDMPlaylistShared [-ID] <guid[]> [-PassThru] [-Refresh] [-VaultMode <VaultMode>]
 [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm] [<CommonParameters>]

Description

Delete one or more shared playlists from the current workspace. If a playlist contains sub-entries, they will also be deleted. The user must have delete permission for each playlist.

Examples

Example 1

PS C:\> Remove-RDMPlaylistShared -ID $playlistId

Deletes the shared playlist with the specified ID.

Example 2

PS C:\> $playlists = Get-RDMPlaylistShared
    PS C:\> $filteredPlaylists = $playlists | Where-Object {$_.ConnectionPlayList.Name -like 'Test*'}
    PS C:\> Remove-RDMPlaylistShared -InputObject $filteredPlaylists -Confirm

Deletes all shared playlists whose names start with 'Test', prompting for confirmation on each.

Example 3

PS C:\> $deleted = Remove-RDMPlaylistShared -ID $id1, $id2 -PassThru

Deletes multiple playlists and returns the deleted playlist objects.

Parameters

-Confirm

Prompts you 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

IDs of the entries to be deleted.

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 entries to delete.

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 all deleted entries, including entries in a deleted folder and sub-entries.

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 the entries in the vault. 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: ''

-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 runs. The cmdlet is 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

System.Guid

IDs of playlist entries to delete.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPlaylistShared

Shared playlist objects from Get-RDMPlaylistShared.

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]

Outputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSPlaylistShared

Notes

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