New-SqlMonitorWindowsHost
Published 21 March 2023
Creates a new temporary object that holds information about a Windows host.
Syntax
New-SqlMonitorWindowsHost [-FullName] <string> [-BaseMonitor] <BaseMonitor> [[-Group] <Group>] [[-UserName] <string>] [[-Password] <string>] [[-AutoDetectClusterName] <bool>] [[-WmiType] <string>] [<CommonParameters>]
Description
The New-SqlMonitorWindowsHost cmdlet creates a new temporary object that holds information about a Windows host. The returned object needs to be passed to Add-SqlMonitorMonitoredObject, as it does not add anything to SQL Monitor on its own.
Parameters
-FullName
<String>
The address of the monitored object e.g. "localhost".
| Aliases | None |
| Required? | true |
| Position? | 1 |
| Default Value | None |
| Accept Pipeline Input | True (ByValue) |
| Accept Wildcard Characters | false |
-BaseMonitor
<BaseMonitor>
The base monitor to add the monitored object to. For more informatiom, see https://documentation.red-gate.com/sm/api/powershell-cmdlet-reference/get-sqlmonitorbasemonitor.
| Aliases | None |
| Required? | true |
| Position? | 2 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Group
<Group>
Group object - use Get-Group or related methods to find the group.
| Aliases | None |
| Required? | false |
| Position? | 3 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-UserName
<String>
The username to connect to the Windows host. If not supplied, using Base Monitor service account.
| Aliases | None |
| Required? | false |
| Position? | 4 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-Password
<String>
The password to connect to the Windows host. If not supplied, using Base Monitor service account.
| Aliases | None |
| Required? | false |
| Position? | 5 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-AutoDetectClusterName
<Boolean>
Auto detect cluster name. This is enabled by default, set to false to disable auto-detection.
| Aliases | None |
| Required? | false |
| Position? | 6 |
| Default Value | True |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-WmiType
<String>
WMI type. Value values are 'winrmhttps', 'winrmhttp' and 'dcom'.
| Aliases | None |
| Required? | false |
| Position? | 7 |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
-ProgressAction
<ActionPreference>
{{ Fill ProgressAction Description }}
| Aliases | None |
| Required? | false |
| Position? | named |
| Default Value | None |
| Accept Pipeline Input | False |
| Accept Wildcard Characters | false |
<CommonParameters>
This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see http://technet.microsoft.com/en-us/library/hh847884.aspx.
Inputs
The input type is the type of the objects that you can pipe to the cmdlet.
-
None.
You cannot pipe input to this cmdlet.
Examples
-------------------------- EXAMPLE 1 --------------------------
$server = New-SqlMonitorWindowsHost -HostName "localhost" -BaseMonitor $BaseMonitor $server | Add-SqlMonitorMonitoredObject
-------------------------- EXAMPLE 2 --------------------------
$server = New-SqlMonitorWindowsHost -HostName "localhost" -BaseMonitor $BaseMonitor -WindowsUserName "win_username" -WindowsPassword "win_pass" $server | Add-SqlMonitorMonitoredObject
