HelpCache/PS_BgpStatistics_v1.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-BgpStatistics</command:name><maml:description><maml:para>Retrieves BGP peering-related message and route advertisement statistics. </maml:para></maml:description><maml:copyright><maml:para /></maml:copyright><command:verb>Get</command:verb><command:noun>BgpStatistics</command:noun><dev:version /></command:details><maml:description><maml:para>The Get-BgpStatistics cmdlet retrieves Border Gateway Protocol (BGP) peering-related message and route advertisement statistics. </maml:para></maml:description><command:syntax><command:syntaxItem><maml:name>Get-BgpStatistics</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="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PeerId,PeerList"><maml:name>PeerName</maml:name><maml:description><maml:para>Specifies an array of peer names for which to retrieve the BGP message and route statistics. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">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 an ID, as a string, for a routing domain. The ID of a routing domain is a unique user-defined alphanumeric string.</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="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="PeerId,PeerList"><maml:name>PeerName</maml:name><maml:description><maml:para>Specifies an array of peer names for which to retrieve the BGP message and route statistics. </maml:para></maml:description><command:parameterValue required="true" variableLength="true">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 an ID, as a string, for a routing domain. The ID of a routing domain is a unique user-defined alphanumeric string.</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>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></maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:inputType></command:inputTypes><command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Management.Infrastructure.CimInstance#BgpStatistics[]</maml:name><maml:uri></maml:uri><maml:description><maml:para /></maml:description></dev:type><maml:description></maml:description></command:returnValue></command:returnValues><command:terminatingErrors /><command:nonTerminatingErrors /><command:examples><command:example><maml:title>Example 1: Retrieve all BPG message and route statistics</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-BgpStatistics PeerName : Tenant-01 TcpConnectionEstablished : 14-03-2013 02:57:04 TcpConnectionClosed : 14-03-2013 02:56:34 OpenMessage: LastSent : 14-03-2013 02:57:04 LastReceived : 14-03-2013 02:57:04 SentCount : 4 ReceivedCount : 4 UpdateMessage: LastSent : 14-03-2013 02:57:04 LastReceived : 14-03-2013 02:57:04 SentCount : 4 ReceivedCount : 4 NotificationMessage: LastSent : 01-01-0001 00:00:00 LastReceived : 13-03-2013 08:24:46 SentCount : 0 ReceivedCount : 2 KeepAliveMessage: LastSent : 14-03-2013 03:00:31 LastReceived : 14-03-2013 03:00:32 SentCount : 1277 ReceivedCount : 1273 RouteRefreshMessage: LastSent : 01-01-0001 00:00:00 LastReceived : 01-01-0001 00:00:00 SentCount : 0 ReceivedCount : 0 IPv4Route: UpdateSentCount : 4 UpdateReceivedCount : 4 WithdrawalSentCount : 0 WithdrawalReceivedCount : 0 IPv6Route: UpdateSentCount : 0 UpdateReceivedCount : 0 WithdrawalSentCount : 0 WithdrawalReceivedCount : 0 </dev:code><dev:remarks><maml:para>This command retrieves the BGP message and route statistics. </maml:para></dev:remarks><command:commandLines><command:commandLine><command:commandText /></command:commandLine></command:commandLines></command:example><command:example><maml:title>Example 2: Retrieve BGP message and route statistics for a routing domain</maml:title><maml:introduction><maml:para></maml:para></maml:introduction><dev:code>PS C:\> Get-BgpStatistics -RoutingDomain Rd_02 PeerName : Tenant-01 TcpConnectionEstablished : 14-03-2013 02:57:04 TcpConnectionClosed : 14-03-2013 02:56:34 OpenMessage: LastSent : 14-03-2013 02:57:04 LastReceived : 14-03-2013 02:57:04 SentCount : 4 ReceivedCount : 4 UpdateMessage: LastSent : 14-03-2013 02:57:04 LastReceived : 14-03-2013 02:57:04 SentCount : 4 ReceivedCount : 4 NotificationMessage: LastSent : 01-01-0001 00:00:00 LastReceived : 13-03-2013 08:24:46 SentCount : 0 ReceivedCount : 2 KeepAliveMessage: LastSent : 14-03-2013 03:00:31 LastReceived : 14-03-2013 03:00:32 SentCount : 1277 ReceivedCount : 1273 RouteRefreshMessage: LastSent : 01-01-0001 00:00:00 LastReceived : 01-01-0001 00:00:00 SentCount : 0 ReceivedCount : 0 IPv4Route: UpdateSentCount : 4 UpdateReceivedCount : 4 WithdrawalSentCount : 0 WithdrawalReceivedCount : 0 IPv6Route: UpdateSentCount : 0 UpdateReceivedCount : 0 WithdrawalSentCount : 0 WithdrawalReceivedCount : 0 </dev:code><dev:remarks><maml:para>This command retrieves the BGP message and route statistics for a routing domain named Rd_02. </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/?LinkID=306224</maml:uri></maml:navigationLink></maml:relatedLinks></command:command> </helpItems> |