Developer Documentation
Citrix Virtual Apps and Desktops 2402 SDK
Current Release 2303 2212 2209 2206 2203 2112 2109 2103 1912

Set-XDMonitor

April 19, 2024
Contributed by: 
C

Sets the Monitoring Database attributes of a Site.

Syntax

Set-XDMonitor
   [-DatabaseMirrorServer <String>]
   [-DatabaseName <String>]
   [-DatabaseServer <String>]
   [-PassThru]
   [-AdminAddress <String>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Sets the Monitoring Database attributes of the Site which has a Controller identified by AdminAddress.

Examples

EXAMPLE 1

For the Site managed by MyController, sets the mirror for the Monitoring Database to MySQLMirror.

Set-XDMonitor -AdminAddress MyController -DatabaseMirrorServer MySQLMirror
<!--NeedCopy-->

EXAMPLE 2

For the Site managed by MyController, sets the SQL Server for the Monitoring Database to MySQLServer and the database name to MyMonitorDatabase.

Set-XDMonitor -AdminAddress MyController -DatabaseServer MySQLServer -DatabaseName MyMonitorDatabase
<!--NeedCopy-->

Parameters

-DatabaseMirrorServer

The mirror database server for the Monitoring Database. If this parameter is not provided, the mirror server is determined by querying the SQL Server hosting the Monitoring Database.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseName

The name of the Monitoring Database. If this is omitted, the name is assumed to be the existing Monitoring Database name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DatabaseServer

The database server for the Monitoring Database. If not provided, the server is assumed to be the SQL Server that is hosting the existing Monitoring Database.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PassThru

Returns the affected record. By default, this cmdlet does not generate any output.

Type: SwitchParameter
Position: Named
Default value: False
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AdminAddress

Specifies the address of the Delivery Controller to which the PowerShell module will connect. This can be provided as a host name or an IP address.

Type: String
Position: Named
Default value: Localhost. Once a value is provided by any cmdlet, this value will become the default.
Required: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

None

You cannot pipe input to this cmdlet.

Outputs

None or Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.Monitor

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.XenDesktopPowerShellSdk.ServiceInterfaces.Configuration.Monitor object.

Notes

The command can fail for the following reasons:

  • The Monitoring Database name and/or database server have not been provided, yet there is no existing database name and/or database server to use as default settings.
  • The Controller identfied by AdminAddress does not have the necessary permissions to access the new Monitoring Database or mirror database on the database server.
  • The new Monitoring Database or mirror database on the database server is not configured for the Site that is associated with the Controller identified by AdminAddress.
Set-XDMonitor
April 19, 2024
Contributed by: 
C
April 19, 2024
Contributed by: 
C

In this article

Site feedback | Privacy and legal terms | Cookie preferences | Consent settings | docs.cloud.com
© 1999- Cloud Software Group, Inc. All rights reserved.