HelpCache/PS_RemoteAccessConnectionStatistics_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-RemoteAccessConnectionStatistics</command:name><maml:description><maml:para>Displays the statistics of real-time, currently active DirectAccess (DA) and VPN connections and the statistics of DA and VPN historical connections for a specified time duration.</maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>RemoteAccessConnectionStatistics</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-RemoteAccessConnectionStatistics cmdlet displays the statistics of the real-time, currently active DirectAccess (DA) and VPN connections and the statistics of DA and VPN historical connections for a specified time duration</maml:para><maml:para>The statistics for active and historical connections starting or ending on a Remote Access (RA) server are stored in the inbox accounting store on that server. This cmdlet retrieves statistics for a specific server. This cmdlet is not impacted by multi-site deployment. -- If neither a start date nor an end date is specified, then statistics for active connections is retrieved. -- In order to retrieve statistics of historical data, a time duration needs to be specified such as a start date, an end date, or both. If only one of them is specified then the time stamp on the first or last record in the accounting database is used to fill the missing information and to create a duration time.</maml:para><maml:para>The statistics of active connections can be explicitly filtered by the resource accessed over the connections or by the security group that users who originated the connections belong to. These filters are not available for statistics of historical connections.</maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-RemoteAccessConnectionStatistics</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>Specifies the IPv4 or IPv6 address, or host name, of the computer on which the RA server computer specific tasks should be run. When this parameter is specified, the statistics on the RA server are retrieved.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>ResourceName</maml:name><maml:description><maml:para>Enables a user to filter the statistics of active connections based on the server, or resource, that the end-user is accessing. This parameter indicates the IP address or host name of the server, or resource, that a user is accessing.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">String</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="RoutingDomainName"><maml:name>RoutingDomain</maml:name><maml:description><maml:para>Specifies the name of the routing domain.</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>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-RemoteAccessConnectionStatistics</maml:name><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="2" aliases=""><maml:name>StartDateTime</maml:name><maml:description><maml:para>Specifies the time duration for which the statistics of historical connections is to be retrieved and indicates the start date. If a date is not specified, then the time stamp of the first record in the accounting database is used by default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByValue)" position="3" aliases=""><maml:name>EndDateTime</maml:name><maml:description><maml:para>Specifies the time duration for which the statistics of historical connections is to be retrieved and indicates the end date. If a date is not specified, then the time stamp of the last record in the accounting database is used by default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue></command:parameter><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>Specifies the IPv4 or IPv6 address, or host name, of the computer on which the RA server computer specific tasks should be run. When this parameter is specified, the statistics on the RA server are retrieved.</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>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: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="Cn"><maml:name>ComputerName</maml:name><maml:description><maml:para>Specifies the IPv4 or IPv6 address, or host name, of the computer on which the RA server computer specific tasks should be run. When this parameter is specified, the statistics on the RA server are 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="True (ByValue)" position="3" aliases=""><maml:name>EndDateTime</maml:name><maml:description><maml:para>Specifies the time duration for which the statistics of historical connections is to be retrieved and indicates the end date. If a date is not specified, then the time stamp of the last record in the accounting database is used by default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue>Date stamp of last record</dev:defaultValue></command:parameter><command:parameter required="false" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases=""><maml:name>ResourceName</maml:name><maml:description><maml:para>Enables a user to filter the statistics of active connections based on the server, or resource, that the end-user is accessing. This parameter indicates the IP address or host name of the server, or resource, that a user is accessing.</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="True (ByPropertyName)" position="named" aliases="RoutingDomainName"><maml:name>RoutingDomain</maml:name><maml:description><maml:para>Specifies the name of the routing domain.</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="True (ByValue)" position="2" aliases=""><maml:name>StartDateTime</maml:name><maml:description><maml:para>Specifies the time duration for which the statistics of historical connections is to be retrieved and indicates the start date. If a date is not specified, then the time stamp of the first record in the accounting database is used by default.</maml:para></maml:description><command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue><dev:type><maml:name>DateTime</maml:name><maml:uri /></dev:type><dev:defaultValue>Date stamp of first record</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#RemoteAccessConnection[]</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. For real-time statistics, the array of RemoteAccessConnection objects consists of the following properties. A separate instance of the object is output for every connection. -- The user name of the user logged in. -- The state of user activity on the connection, idle or active. -- The bandwidth used by the connection. -- The IPv4 address of the client computer. -- The IPv6 address of the client computer. -- The host name of the client computer. -- The internet-facing IP address of the client. -- The tunnel type: VPN tunnel or ESP tunnel for DA. -- The transition technology used in the DA connection: native IPv6, Teredo, IPHTTPS, Isatap, 6to4. -- The time stamp when the connection was setup. -- The time duration of connection. -- The total number of bytes received on the connection so far. -- The total number of bytes sent on the connection so far. -- The connection type: DA or VPN. -- The health status: Indicates the NAP health status. -- The authentication method used to authenticate the user and computer in VPN and DA. For accounting statistics, the array of RemoteAccessConnection objects consists of the following properties. A separate instance of the object is outputted for every connection. -- The user name of the user logged in. -- The IPv4 address of the client computer. -- The IPv6 address of the client computer. -- The host name of the client computer. -- The internet-facing IP address of the client. -- The tunnel type: VPN tunnel or ESP tunnel for DA. -- The transition technology used in the DA connection: native IPv6, Teredo, IPHTTPS, Isatap, 6to4. -- The time stamp when the connection was setup. -- The time duration of connection. -- The total number of bytes received on the connection so far. -- The total number of bytes sent on the connection so far. -- The connection type: DA or VPN. -- The health status: Indicates the NAP health status. -- The authentication method used to authenticate the user and computer in VPN and DA. </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-RemoteAccessConnectionStatistics | Format-List –Property * ClientIPAddress : {10.1.1.11, 2002:836b:2:2000:7407:f734:9281:f9a3} UserName : {corp.contoso.com \remoteuser1} ConnectionDuration(s) : 220 ConnectionType : Vpn AccessStatus : User Mode/Full Corp Access PS C:\>Disconnect-VpnUser -HostIPAddress 10.1.1.11 -PassThru10.1.1.11 PS C:\>Get-RemoteAccessConnectionStatistics | Format-List –Property * </dev:code><dev:remarks><maml:para>This example disconnects the connection by specifying the IP address of the host from which it originates. The output of the disconnect cmdlet displays the IP address of the disconnected host. For this example there is one active VPN connection. The output of this cmdlet is piped to the <maml:navigationLink><maml:linkText>Format-List</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet to display the details of the active connection in a list format. </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>A start and an end date boundaries are first established for the required data using the <maml:navigationLink><maml:linkText>Get-Date</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet. PS C:\>$startdate = Get-Date –Date "12/16/2011" PS C:\>$enddate = Get-Date –Date "12/23/2011" This cmdlet gets all of the connections made between start and end date and pipes it into the <maml:navigationLink><maml:linkText>Export-Csv</maml:linkText><maml:uri></maml:uri></maml:navigationLink> cmdlet to generate a .csv file. PS C:\>Get-RemoteAccessConnectionStatistics –StartDateTime $startdate –EndDateTime $enddate | Export-Csv –Path "data.csv" </dev:code><dev:remarks><maml:para>This example gets a list of historic connections and export them to a .csv file.</maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>EXAMPLE 3</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code> PS C:\>$enddate = Get-Date –Date "12/23/2011" The data is exported from server start date to the specified end date. Note: The starting date does not need to be explicitly specified here. PS C:\>Get-RemoteAccessConnectionStatistics –EndDateTime $enddate | Export-Csv –Path "data.csv" </dev:code><dev:remarks><maml:para>This example exports a list of historic connections up to a specific date.</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=289528</maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Export-Csv</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Format-List</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-Date</maml:linkText><maml:uri></maml:uri></maml:navigationLink><maml:navigationLink><maml:linkText>Get-RemoteAccessConnectionStatisticsSummary</maml:linkText><maml:uri /></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |