Get-RemoteAccessHealth
Get-RemoteAccessHealth
Obtains the current health of a RemoteAccess (RA) deployment.
Sintaxis
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>]
Descripción detallada
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.
Parámetros
-AsJob
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-CimSession<CimSession[]>
Ejecuta el cmdlet en una sesión remota o en un equipo remoto. Escriba un nombre de equipo o un objeto de sesión, como la salida de un cmdlet New-CimSession o Get-CimSession. El valor predeterminado es la sesión actual en el equipo local.
Alias |
Session |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-Cluster
Indicates that the cmdlet gets the health for the entire cluster. If you specify both this parameter and the ComputerName parameter, the cmdlet gets the health of the cluster to which the computer belongs. If you specify this parameter in a multisite scenario, the cmdlet gets the health of the cluster in the site for the server on which you run the cmdlet. You can use the ComputerName parameter to specify the computer that runs the cmdlet.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
Cn |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-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.
Alias |
ninguno |
¿Requerido? |
true |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
True (ByPropertyName) |
¿Aceptar caracteres comodín? |
false |
-Refresh
Indicates that the cmdlet recomputes the health details for the computer, cluster, or entry point that you specify for the cmdlet.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
-ThrottleLimit<Int32>
Especifica el número máximo de operaciones simultáneas que se pueden establecer para ejecutar el cmdlet. Si se omite este parámetro o es especifica un valor de 0
, Windows PowerShell ® calcula un límite óptimo para el cmdlet en función del número de cmdlets de CIM que se estén ejecutando en el equipo. El límite solo se aplica al cmdlet actual, no a la sesión ni al equipo.
Alias |
ninguno |
¿Requerido? |
false |
¿Posición? |
named |
Valor predeterminado |
ninguno |
¿Aceptar canalización? |
false |
¿Aceptar caracteres comodín? |
false |
<CommonParameters>
Este cmdlet admite los siguientes parámetros comunes: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer y -OutVariable. Para obtener más información, consulte about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).
Entradas
El tipo de entrada es el tipo de los objetos que se pueden canalizar al cmdlet.
- None
Salidas
El tipo de resultado es el tipo de objetos que emite el cmdlet.
Microsoft.Management.Infrastructure.CimInstance#RemoteAccessHealthMonitor[]
El objeto
Microsoft.Management.Infrastructure.CimInstance
es una clase contenedora que muestra objetos de Instrumental de administración de Windows (WMI). La ruta de acceso después del signo de número (#
) proporciona el espacio de nombres y el nombre de clase del objeto WMI subyacente.
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
Ejemplos
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