GetByCluster method of the PS_RemoteAccessHealth class
This cmdlet is used to obtain the current health of a Remote Access deployment.
Health of a specific Remote Access server
Health of a load balancing cluster
Health of a site, in case of a multisite deployment - this again corresponds to the health of a single server or health of a cluster at that site
Syntax
uint32 GetByCluster(
[in] string ComputerName,
[in] boolean Refresh,
[in] boolean Cluster,
[out] RemoteAccessHealthMonitor cmdletOutput[]
);
Parameters
-
ComputerName [in]
-
Indicates the IPv4/IPv6 address or hostname of the computer on which the cmdlet needs to be executed and health retrieved. When ComputerName is specified the health of that Remote Access server is returned
-
Refresh [in]
-
Specifying this parameter indicates that the health details for the specified ComputerName/Cluster or EntryPoint should be re-computed.
-
Cluster [in]
-
Specifying this parameter indicates that the health for the entire cluster needs to be retrieved. If both cluster and ComputerName are specified then the health of the cluster to which the ComputerName belongs is returned. If cluster is specified in a multi-site scenario then the health of the cluster in the site to which the server on which the cmdlet is executed belongs is returned. The server could also be represented by using the ComputerName parameter
-
cmdletOutput [out]
-
Objects consisting of the following properties for cluster, server and components of server
Component name
Remote Access server address
HealthState
TimeStamp
OperationStatus
Id
ErrorDesc
ErrorCause
ErrorResoln
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 |
| Namespace |
Root\Microsoft\Windows\RemoteAccess |
| MOF |
|
| DLL |
|