Set-RDMPlaylistShared

Synopsis

Save a shared playlist in the current workspace.

Syntax

__AllParameterSets

Set-RDMPlaylistShared [-Playlist] <PSPlaylistShared> [[-Connections] <PSConnection[]>]
 [-ImportConnection] [-PrivateVault] [-ForcePromptAnswer <DialogResult[]>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

Description

Save a shared playlist in the current workspace. It can be saved as a user playlist with the 'PrivateVault' switch. To add a connection to the playlist, either use the 'Connection' parameter or directly modify the list.To remove connections from the playlist, it must be done directly from the list. See examples for more information. The 'ImportConnection' switch will save all modifications to the connections contained in the playlist. Those connections are store in the 'Connections' property of the playlist. This is a shortcut to modify conenctions contained in the playlist.

Examples

Example 1

PS C:\> $playlist = Get-RDMPlaylistShared | Where-Object { $_.ConnectionPlayList.Name -eq 'MyPlaylist' }
PS C:\> $playlist.ConnectionPlayList.Remove('12345678-1234-1234-123456781234')
PS C:\> $newItem = @{
         ConnectionID = '12341234-1234-1234-1234-123412345678'
         GroupMain = 'My\Group'
         }
PS C:\> $null = $playlist.ConnectionPlayList.Add($newItem)
PS C:\> Set-RDMPlaylistShared -Playlist $playlist

Manage playlist connections by adding a new one and removing an old one directly in the list.

Example 2

PS C:\> $playlist = Get-RDMPlaylistShared | Where-Object { $_.ConnectionPlayList.Name -eq 'MyPlaylist' }
PS C:\> $connection = Get-RDMEntry -Name 'ConnectionToAddInPlaylist'
PS C:\> Set-RDMPlaylistShared -Playlist $playlist -Connection $connection

Add a connection to the playlist using the 'Connection' parameter.

Example 3

PS C:\> $playlist = Get-RDMPlaylistShared -ExportConnections | Where-Object { $_.ConnectionPlayList.Name -eq 'MyPlaylist' }
PS C:\> $playlist.Connections | ForEach-Object { $_.Description = "Part of $($playlist.ConnectionPlayList.Name)" }
PS C:\> Set-RDMPlaylistShared -Playlist $playlist -ImportConnection

Add a description to all connections contained in the playlist.

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

-Connections

Connections to add in the playlist.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 1
  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: ''

-ImportConnection

Import the playlist connections, stored in the Connections property of the given playlist, to the workspace.

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

-Playlist

Specifies the the shared playlist to set/save.

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

-PrivateVault

Save the shared playlist in the private vault.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: true
  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.

Notes

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