NAME

Get-DcsRecordingEndpoint

SYNOPSIS

Returns the data for the recording endpoints. Each endpoint may be connected to a local DataCore Server or a remote SQL DataBase.

SYNTAX

Get-DcsRecordingEndpoint   [ -Endpoint <Object> ]   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Returns the data for the recording endpoints. Each endpoint may be connected to a local DataCore Server or remote SQL Server. The "Enabled" property determines if the user can modify the endpoint. One endpoint can be used from multiple (recording) sessions (for example both the "ChargeBackSession" and "UserRecordingSession").

PARAMETERS

-Endpoint<Object>
The RecordingEndpointData object, name or ID that identifies a recording endpoint. If a specific recording endpoint is not specified, all recording endpoints in the server group will be returned.

Required: false
Position: 1
Default value:
Accept pipeline input: true (ByValue)
Accept wildcard characters: false

-Connection<String>
Alias of the connection to the server group. If not specified, the default connection will be used.

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

-PipelineVariable<String>

Required: false
Position: named
Default value:
Accept pipeline input: false
Accept wildcard characters: false

INPUTS

RecordingEndpointData : Object that identifies and describes the recording endpoint, which represents the recording server, database, and gives the current state of the recording service for the database.

OUTPUTS

RecordingEndpointData : Object that identifies and describes the recording endpoint, which represents the recording server, database, and gives the current state of the recording service for the database.

NOTES

This cmdlet replaces the obsolete cmdlet Get-DcsRecordingServer. Also see Set-DcsRecordingEndpointProperties.

EXAMPLES


-------------- Example 1 Returns data for all recording endpoints in the server group. --------------
Get-DcsRecordingEndpoint
		

The cmdlet Get-DcsRecordingEndpoint is invoked without parameters to return all recording endpoints in the server group. Two objects are returned; one for the user-defined performance recording (configured by the user) and one for historical performance monitoring (assigned by the software).

CurrentState:Connected
Alias:!UserRecordingEndpoint
EndpointType:LocalDb
Readonly:False
Settings:DataCore.Executive.LocalRecordingEndpointSettings
Sequencenumber:4175
Id:7A46DCA6-85CA-4E52-9329-A2CD7C565B14
Caption:User recording endpoint
ExtendedCaption:User recording endpoint
Internal:False
   
CurrentState:Connected
Alias:!HistoricalMonitoringEndpoint
EndpointType:MultiPeriodLocalDb
Readonly:True
Settings:DataCore.Executive.LocalRecordingEndpointSettings
Sequencenumber:3677
Id:EAC11308-BD78-4EFF-9CDD-C46AE4CED481
Caption:Historical monitoring recording endpoint
ExtendedCaption:Historical monitoring recording endpoint
Internal:False