NAME

Set-DcsRecordingEndpointProperties

SYNOPSIS

Sets or changes the properties of a recording endpoint; such as local or remote SQL Server, and in case of a remote SQL Server; database name and credentials.

SYNTAX

Set-DcsRecordingEndpointProperties   -Endpoint <Object>   -Server <Object>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Set-DcsRecordingEndpointProperties   -Endpoint <Object>   -RemoteServer <String>   -DatabaseName <String>   -UserName <String>   -Password <String>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Set-DcsRecordingEndpointProperties   -Endpoint <Object>   -RemoteServer <String>   -DatabaseName <String>   -Credentials <PSCredential>   [ -Connection <String> ]   [ -PipelineVariable <String> ]

Set-DcsRecordingEndpointProperties   -Endpoint <Object>   -RemoteServer <String>   -DatabaseName <String>   -UseWindowsAuthentication   [ -Connection <String> ]   [ -PipelineVariable <String> ]

DESCRIPTION

Sets or changes the properties of a recording endpoint; such as local or remote SQL Server, and in case of a remote SQL Server; database name and credentials.

PARAMETERS

-Endpoint<Object>

The RecordingEndpointData object, name (caption) or ID that identifies a recording endpoint.

Required: true

Position: named

Default value:

Accept pipeline input: true (ByValue)

Accept wildcard characters: false

-Server<Object>

ServerHostData object, Id, or computer name that identifies the local recording server.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Connection<String>

Alias of the connection to the server group. If not specified, the default connection is 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

-RemoteServer<String>

The hostname that identifies a remote SQL server.

Required: true

Position: 1

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-DatabaseName<String>

Name of the SQL database where performance data will be stored on a remote SQL server. If the database does not exist, it will be created.

Required: true

Position: 2

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-UserName<String>

Username configured for the remote SQL Server login.

Required: true

Position: 3

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Password<String>

Password configured for the remote SQL Server login.

Required: true

Position: 4

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-Credentials<PSCredential>

The PSCredential object containing user name and password for a remote SQL Server. This object can be obtained by invoking the Windows PowerShell cmdlet Get-Credential, see Example 3. In this manner, credentials can be passed through the object instead of typing the credentials.

Required: true

Position: 3

Default value:

Accept pipeline input: false

Accept wildcard characters: false

-UseWindowsAuthentication<SwitchParameter>

Use this parameter to indicate that Windows login credentials will be used to authenticate.

Required: true

Position: named

Default value:

Accept pipeline input: false

Accept wildcard characters: false

INPUTS

RecordingEndpointData : Object that identifies the endpoint.

OUTPUTS

RecordingEndpointData : The object 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 Set-DcsRecordingServer.

EXAMPLES

Set-DcsRecordingEndpointProperties -Endpoint "User recording endpoint" -Server SSVVM02
		

Set-DcsRecordingEndpointProperties -Endpoint "User recording endpoint" -RemoteServer "SQLServer" -DatabaseName "DcsPerf" -UserName "SQLUser" -Password "SQLpw001!"
		

Set-DcsRecordingEndpointProperties -Endpoint "User recording endpoint" -RemoteServer "SQLServer" -DatabaseName "DcsPerf" -UseWindowsAuthentication
		

$SQLCreds = Get-Credential
Get-DcsRecordingEndpoint -Endpoint "User recording endpoint"  | Set-DcsRecordingEndpointProperties -RemoteServer "Semkovo1" -DatabaseName "DcsPerf" -Credentials $SQLCreds
			

cmdlet Get-Credential at command pipeline position 1
Supply values for the following parameters:
Credential