Online Help > PowerShell Scripting

Get-RDMSession

SYNOPSIS

Retrieve the list of available sessions.

 

SYNTAX

Get-RDMSession -CaseSensitive [CaseSensitive] <SwitchParameter> -GroupName [GroupName] <String> -IncludeDocumentsStoredInDatabase [IncludeDocumentsStoredInDatabase] <SwitchParameter> -IncludeLocalPlaylists [IncludeLocalPlaylists] <SwitchParameter> -IncludeSubFolders [IncludeSubFolders] <SwitchParameter> -IncludeUserSpecificSettings [IncludeUserSpecificSettings] <SwitchParameter> -Name [Name] <String> [<CommonParameters>]

 

DESCRIPTION

Retrieve the list of available sessions for the current selected data source.

 

PARAMETERS

  -CaseSensitive <SwitchParameter>

Case sensitive

 

  -GroupName <String>

GroupName

 

  -IncludeDocumentsStoredInDatabase <SwitchParameter>

Include attachment from documents

 

  -IncludeLocalPlaylists <SwitchParameter>

Include dependable connections and local playlists from playlist connection

 

  -IncludeSubFolders <SwitchParameter>

Include subfolders from the group name

 

  -IncludeUserSpecificSettings <SwitchParameter>

Include user specific settings

 

  -Name <String>

Session name

 

  <CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable,OutBuffer and OutVariable.For more information, type, "get-help about_commonparameters".

 

NOTES

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

 

EXAMPLE 1

PS C:\> Get-RDMSession

 

Retrieves the list of available sessions.

 

EXAMPLE 2

PS C:\> $list = Get-RDMSession; $list[0]

 

Retrieves the list of available sessions and displays the first item.

 

EXAMPLE 3

PS C:\> $list = Get-RDMSession; $list[1].Name = "New Name";Set-RDMSession $list[1]

 

Retrieves the list of available sessions, modify the name of the second session, update the session.

 

RELATED LINKS

Get-RDMDataSource

Set-RDMDataSource

Set-RDMSession