Get-RemoteAccessHealth

Get-RemoteAccessHealth

Obtains the current health of a RemoteAccess (RA) deployment.

Syntax

Parameter Set: Cluster
Get-RemoteAccessHealth [-AsJob] [-CimSession <CimSession[]> ] [-Cluster] [-ComputerName <String> ] [-Refresh] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Parameter Set: EntrypointName
Get-RemoteAccessHealth -EntrypointName <String> [-AsJob] [-CimSession <CimSession[]> ] [-ComputerName <String> ] [-Refresh] [-ThrottleLimit <Int32> ] [ <CommonParameters>]

Detailed Description

The Get-RemoteAccessHealth cmdlet obtains the current health of a RemoteAccess (RA) deployment as follows.
-- Health of a specific Remote Access server.
-- Health of a load balancing cluster.
-- Health of a site, in case of a multi-site deployment: this again corresponds to the health of a single server or health of a cluster at that site.

The health information returned for a single server consists of the following.
-- Server address.
-- Rolled up health of the server: This depends on the health of the individual technology features that RA is comprised. The following rule applies: If all features are healthy, then the server is healthy. If one or more features are in the yellow health state, then the health of the server is also yellow. If one or more features are in the red health state, then the health of the server is also red; this applies even if one or more features are in yellow health state.
-- Time stamp when the health of the server changed.
-- Health of the individual RA features. This comprises of the following.
---- Health state of a feature: The roll-up of the health of individual pre-defined monitors that determine the health of the feature. Every monitor causes the feature to go into red or yellow health. If multiple monitors are unhealthy, then the roll-up rules are similar to the one for server health roll-up defined above.
---- Time stamp when the health of the feature last changed.
---- If a DA feature is not healthy, then the details of the monitors that are unhealthy.

The health information returned for a cluster is quite similar to the server health and consists of the following.
-- Rolled up health of cluster: This depends on the health of each of the servers present in the cluster. The roll-up rules are similar to the feature health roll-up for server.
-- Time stamp when health of the cluster changed.
-- Health of the individual servers in the cluster: The health information described above is returned for each of the servers.

Parameters

-AsJob

-CimSession<CimSession[]>

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

-Cluster

Specifying this parameter indicates that the health for the entire cluster needs to be retrieved. If this parameter and the ComputerName parameter are specified, then the health of the cluster to which the computer name belongs is returned. If this parameter 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 run is returned. The server could also be represented by using the ComputerName parameter.

-ComputerName<String>

Indicates the IPv4 or IPv6 address, or host name, of the computer on which this cmdlet needs to be run and the health retrieved. When this parameter is specified, then the health of that RA server is returned.

-EntrypointName<String>

Specifies the identity of a site in a multi-site deployment whose health needs to be retrieved.
If both this parameter and ComputerName parameter are specified and the computer name does not belong to the site represented by the entry point name, then this parameter takes precedence and the site health is retrieved.

-Refresh

Specifying this parameter indicates that the health details for the specified computer name or cluster, or entry point name, should be recomputed.

-ThrottleLimit<Int32>

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

• None

Outputs

The output type is the type of the objects that the cmdlet emits.

• Microsoft.Management.Infrastructure.CimInstance#RemoteAccessHealthMonitor[]

  The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.
  The array of RemoteAccessHealthMonitor objects consists of the following properties for cluster, server and components of the server:
  -- Component name
  -- Remote Access server address
  -- HealthState
  -- TimeStamp
  -- OperationStatus
  -- ID
  -- ErrorDesc
  -- ErrorCause
  -- ErrorResoln

Examples

EXAMPLE 1

This example displays the health of a specific server.

PS C:\> Get-RemoteAccessHealth

EXAMPLE 2

This example displays the health of a cluster containing two Remote Access servers.

PS C:\> Get-RemoteAccessHealth –Cluster

Related topics

Get-DAServer

Get-RemoteAccess