HelpCache/PS_RemoteAccessHealth_v1.0.0.cdxml-help.xml
|
<?xml version = "1.0" encoding = "utf-8" ?>
<helpItems schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"><command:details><command:name>Get-RemoteAccessHealth</command:name><maml:description><maml:para>Obtains the current health of a RemoteAccess (RA) deployment.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>RemoteAccessHealth</command:noun><dev:version /></command:details><maml:description><maml:para>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. </maml:para><maml:para>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. </maml:para><maml:para>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. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-RemoteAccessHealth</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>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 <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Cluster</maml:name><maml:description><maml:para>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.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Cn"><maml:name>ComputerName</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Refresh</maml:name><maml:description><maml:para>Indicates that the cmdlet recomputes the health details for the computer, cluster, or entry point that you specify for the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter></command:syntaxItem><command:syntaxItem><maml:name>Get-RemoteAccessHealth</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>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 <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Cn"><maml:name>ComputerName</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Refresh</maml:name><maml:description><maml:para>Indicates that the cmdlet recomputes the health details for the computer, cluster, or entry point that you specify for the cmdlet.</maml:para></maml:description></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>EntrypointName</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter></command:syntaxItem></command:syntax><command:parameters><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>AsJob</maml:name><maml:description><maml:para>Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete. The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the <maml:navigationLink><maml:linkText>Receive-Job</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. For more information about Windows PowerShell® background jobs, see <maml:navigationLink><maml:linkText>about_Jobs</maml:linkText><maml:uri></maml:uri></maml:navigationLink>.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="false" position="named" aliases="Session"><maml:name>CimSession</maml:name><maml:description><maml:para>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 <maml:navigationLink><maml:linkText>New-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> or <maml:navigationLink><maml:linkText>Get-CimSession</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. The default is the current session on the local computer.</maml:para></maml:description><command:parameterValue required="true" variableLength="true">CimSession[]</command:parameterValue><dev:type><maml:name>CimSession[]</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Cluster</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases="Cn"><maml:name>ComputerName</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="true" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>EntrypointName</maml:name><maml:description><maml:para>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. </maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue><dev:type><maml:name>String</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>Refresh</maml:name><maml:description><maml:para>Indicates that the cmdlet recomputes the health details for the computer, cluster, or entry point that you specify for the cmdlet.</maml:para></maml:description><command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue><dev:type><maml:name>SwitchParameter</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named" aliases=""><maml:name>ThrottleLimit</maml:name><maml:description><maml:para>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.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">Int32</command:parameterValue><dev:type><maml:name>Int32</maml:name><maml:uri /></dev:type><dev:defaultValue></dev:defaultValue></command:parameter></command:parameters><command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para></maml:para></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#RemoteAccessHealthMonitor[]</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description><maml:para>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 </maml:para></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>EXAMPLE 1</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-RemoteAccessHealth Component RemoteAccessServer HealthState TimeStamp Id OperationStatus --------- ------------------ ----------- --------- -- --------------- Server localhost Error 2/1/2012 1:59:32 AM 6to4 localhost OK 2/1/2012 1:59:20 AM Vpn Addressing localhost OK 2/1/2012 1:59:20 AM Network Security localhost OK 2/1/2012 1:59:20 AM Dns localhost OK 2/1/2012 2:04:10 AM IP-Https localhost OK 2/1/2012 1:59:20 AM Nat64 localhost OK 2/1/2012 1:59:19 AM Dns64 localhost OK 2/1/2012 1:59:16 AM IPsec localhost OK 2/1/2012 1:59:16 AM Kerberos localhost Disabled 2/1/2012 1:59:16 AM Domain Controller localhost OK 2/1/2012 2:04:10 AM Management Servers localhost Disabled 2/1/2012 1:59:13 AM Network Location ... localhost OK 2/1/2012 2:04:11 AM Otp localhost Disabled 2/1/2012 1:59:13 AM High Availability localhost Error 2/1/2012 1:59:32 AM {2148401155,... {NLB state, NLB drive... Isatap localhost Disabled 2/1/2012 1:59:13 AM Vpn Connectivity localhost OK 2/1/2012 1:59:13 AM Teredo localhost Disabled 2/1/2012 1:59:13 AM Network Adapters localhost OK 2/1/2012 1:59:13 AM Services localhost Unknown 2/1/2012 2:04:10 AM 3221225474 Server configuration ... </dev:code><dev:remarks><maml:para>This example displays the health of a specific server.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 2</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\>Get-RemoteAccessHealth –Cluster Component RemoteAccessServer HealthState TimeStamp Id OperationStatus --------- ------------------ ----------- --------- -- --------------- Cluster Error 2/1/2012 1:59:32 AM Server N1.CONTOSO.COM Error 2/1/2012 1:59:32 AM 6to4 N1.CONTOSO.COM OK 2/1/2012 1:59:20 AM Vpn Addressing N1.CONTOSO.COM OK 2/1/2012 1:59:20 AM Network Security N1.CONTOSO.COM OK 2/1/2012 1:59:20 AM Dns N1.CONTOSO.COM OK 2/1/2012 2:04:10 AM IP-Https N1.CONTOSO.COM OK 2/1/2012 1:59:20 AM Nat64 N1.CONTOSO.COM OK 2/1/2012 1:59:19 AM Dns64 N1.CONTOSO.COM OK 2/1/2012 1:59:16 AM IPsec N1.CONTOSO.COM OK 2/1/2012 1:59:16 AM Kerberos N1.CONTOSO.COM Disabled 2/1/2012 1:59:16 AM Domain Controller N1.CONTOSO.COM OK 2/1/2012 2:04:10 AM Management Servers N1.CONTOSO.COM Disabled 2/1/2012 1:59:13 AM Network Location ... N1.CONTOSO.COM OK 2/1/2012 2:04:11 AM Otp N1.CONTOSO.COM Disabled 2/1/2012 1:59:13 AM High Availability N1.CONTOSO.COM Error 2/1/2012 1:59:32 AM {2148401155,... {NLB state, NLB drive... Isatap N1.CONTOSO.COM Disabled 2/1/2012 1:59:13 AM Vpn Connectivity N1.CONTOSO.COM OK 2/1/2012 1:59:13 AM Teredo N1.CONTOSO.COM Disabled 2/1/2012 1:59:13 AM Network Adapters N1.CONTOSO.COM OK 2/1/2012 1:59:13 AM Services N1.CONTOSO.COM Unknown 2/1/2012 2:04:10 AM 3221225474 Server configuration ... Server N2.CONTOSO.COM OK 2/1/2012 5:48:35 AM 6to4 N2.CONTOSO.COM OK 2/1/2012 5:43:39 AM Vpn Addressing N2.CONTOSO.COM OK 2/1/2012 5:43:39 AM Network Security N2.CONTOSO.COM OK 2/1/2012 5:43:39 AM Dns N2.CONTOSO.COM OK 2/1/2012 5:48:35 AM IP-Https N2.CONTOSO.COM OK 2/1/2012 5:43:39 AM Nat64 N2.CONTOSO.COM OK 2/1/2012 5:43:39 AM Dns64 N2.CONTOSO.COM OK 2/1/2012 5:43:38 AM IPsec N2.CONTOSO.COM OK 2/1/2012 5:43:38 AM Kerberos N2.CONTOSO.COM Disabled 2/1/2012 5:43:38 AM Domain Controller N2.CONTOSO.COM OK 2/1/2012 5:43:38 AM Management Servers N2.CONTOSO.COM Disabled 2/1/2012 5:43:35 AM Network Location ... N2.CONTOSO.COM OK 2/1/2012 5:48:35 AM Otp N2.CONTOSO.COM Disabled 2/1/2012 5:43:35 AM High Availability N2.CONTOSO.COM OK 2/1/2012 5:48:35 AM Isatap N2.CONTOSO.COM Disabled 2/1/2012 5:43:35 AM Vpn Connectivity N2.CONTOSO.COM OK 2/1/2012 5:43:35 AM Teredo N2.CONTOSO.COM Disabled 2/1/2012 5:43:35 AM Network Adapters N2.CONTOSO.COM OK 2/1/2012 5:43:35 AM Services N2.CONTOSO.COM OK 2/1/2012 5:48:35 AM </dev:code><dev:remarks><maml:para>This example displays the health of a cluster containing two Remote Access servers.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example></command:examples><maml:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText><maml:uri>http://go.microsoft.com/fwlink/p/?linkid=289530</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-DAServer</maml:linkText><maml:uri /></maml:navigationLink><maml:navigationLink><maml:linkText>Get-RemoteAccess</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |