GetByEntrypointName method of the PS_RemoteAccessHealth class

This cmdlet is used to obtain the current health of a Remote Access deployment.

1. Health of a specific Remote Access server

2. Health of a load balancing cluster

3. 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 GetByEntrypointName(
  [in]  string                    ComputerName,
  [in]  boolean                   Refresh,
  [in]  string                    EntrypointName,
  [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.

EntrypointName [in]

Entrypoint refers to the identity of a site in a multisite deployment whose health needs to be retrieved.

If both entrypoint and ComputerName are specified and the ComputerName does not belong to the site represented by the entrypoint then the entrypoint takes precedence and its health is retrieved

cmdletOutput [out]

Objects consisting of the following properties for cluster, server and components of server

1. Component name

2. Remote Access server address

3. HealthState

4. TimeStamp

5. OperationStatus

6. Id

7. ErrorDesc

8. ErrorCause

9. ErrorResoln

Requirements

Minimum supported client	None supported
Minimum supported server	Windows Server 2012
Namespace	Root\Microsoft\Windows\RemoteAccess
MOF	RAMgmtPSProvider.mof
DLL	RAMgmtPSProvider.dll

See also

PS_RemoteAccessHealth