H3C S9500 Command Manual-Release1648[v1.24]-08 System Volume

HomeSupportSwitchesH3C S9500 Series SwitchesReference GuidesCommand ReferencesH3C S9500 Command Manual-Release1648[v1.24]-08 System Volume
05-NQA Commands
Title Size Download
05-NQA Commands 98.43 KB

Chapter 1  NQA Configuration Commands

1.1  NQA Configuration Commands

1.1.1  count

Syntax

count times

undo count

View

NQA test group view

Parameters

times: Number of probe packets to be sent, in the range 1 to 15.

Description

Use the count command to configure the number of probe packets to be sent.

Use the undo count command to restore the default value.

By default, one probe packet is sent.

 

&  Note:

If you specify a value bigger than 1 for the times argument, the system operates in either of the following two ways after sending the first probe packet.

l      If the system receives a response packet, it sends a second probe packet.

l      If the system does not receive a response packet, it sends a second probe packet after test operation timeout.

This process goes on until the last probe packet is sent.

 

Examples

# Set the number of probe packets to be sent to 5.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] count 5

1.1.2  datafill

Syntax

datafill text

undo datafill

View

NQA test group view

Parameters

text: Filler data of the test packet. It can be a string no more than 230 bytes in length.

Description

Use the datafill command to configure the filler data of the test packet.

Use the undo datafill command to restore the default value.

By default, no filler data of the test packet is configured, that is, the test packet is empty.

Related commands: datasize.

 

&  Note:

When filling the ICMP packet, if no filler data of the packet is set, the system will in turn fill the bytes with values 0, 1, 2… into the free filling space of the packet. Otherwise, the system uses text to fill in the space. If the content of text is too long, the system uses the part of the content in the front; if too short, the system fills the content in a cyclic way.

 

Examples

# Configure the filler data of the test packet as “Hello I’m here.”

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] datafill Hello I’m here.

1.1.3  datasize

Syntax

datasize size

undo datasize

View

NQA test group view

Parameters

size: Size, in bytes, of the test packet, in the range 20 to 8100.

Description

Use the datasize command to configure the size of the filler data of the test packet.

Use the undo datasize command to restore the default value.

By default, the size of filler data of the test packet is 56 bytes.

Related commands: datafill.

 

&  Note:

The filler data refers to the area that can be freely filled in the packet, that is, the area outside the ICMP packet header. If the filler data is big in size, when sending the packet, the system fragments the packet into pieces on demand.

 

Examples

# Set the filler data size of the test packet to 50 bytes.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] datasize 50

1.1.4  debugging nqa

Syntax

debugging nqa { all | error | event }

undo debugging nqa { all | error | event }

View

User view

Parameters

all: Specifies all types of debugging for NQA.

error: Specifies debugging for NQA error information.

event: Specifies debugging for NQA event information.

Description

Use the debugging nqa command to enable debugging for NQA.

Use the undo debugging nqa command to disable debugging for NQA.

Examples

# Enable debugging for NQA error information.

<H3C> debugging nqa error

1.1.5  description

Syntax

description text

undo description

View

NQA test group view

Parameters

text: Brief description of the operation, 1 to 230 characters long.

Description

Use the description command to configure the brief description of the operation.

Use the undo description command to delete the configured description information.

By default, there is no description information of the operation.

Examples

# Describes the test group as “Cary’s icmp test”.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] description Cary’s icmp test

1.1.6  destination-ip

Syntax

destination-ip ip-address

undo destination-ip

View

NQA test group view

Parameters

ip-address: Destination IP address of the test.

Description

Use the destination-ip command to configure the destination IP address of the test.

Use the undo destination-ip command to delete the configured destination IP address.

By default, no destination IP address of the test is configured.

The test can be performed only after the destination IP address is configured.

Examples

# Set the destination IP address of the test to 192.168.80.80.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] destination-ip 192.168.80.80

1.1.7  display nqa

Syntax

display nqa [ results | history ] [ administrator-name test-tag ]

View

Any view

Parameters

results: Displays the test results.

history: Displays the history test record information.

administrator-name: Name of the administrator who creates the operation.

test-tag: Tag of the test operation.

Description

Use the display nqa command to display the result of the test.

If you do not specify the administrator-name and the test-tag arguments, results of all test groups are displayed. Otherwise, only the result of the specified test group is displayed.

Examples

# Display the test results.

<H3C> display nqa results administrator icmp

  NQA entry(admin administrator, tag icmp) test results:

      Destination ip address:192.168.80.80

      Vpn-instance: NULL

      Send operation times: 5             Receive response times: 5

      Min/Max/Average Round Trip Time: 1/2/1

      Square-Sum of Round Trip Time: 13

      Last complete test time: 2005-11-02 16:28:55.0

    Extended results:

      Packet lost in test: 0%

      Disconnect operation number:0        Operation timeout number:0

      System busy operation number:0       Connection fail number:0

      Operation sequence errors:0          Drop operation number:0

      Other operation errors:0

Table 1-1 display nqa result command output description

Field

Description

Destination ip address

Destination IP address

Vpn-instance

VPN identification, NULL means no identification is set.

Send operation times

Number of times the operation is sent

Receive response times

Number of times of the successful test operations

Min/Max/Average Round Trip Time

Minimum/maximum/average round trip time

Square-Sum of Round Trip Time

The square sum of the round trip time

Last complete test time

Time of the last successful test

Packet lost in test

Ratio of lost packets

Disconnect operation number

Number of times of disconnections by the opposite side

System busy operation number

Number of times the test fails because the system is busy

Operation sequence errors

Number of received sequence error packets

Operation timeout number

Number of timeouts

Connection fail number

Number of connection failures

Drop operation number

Number of system resource allocation errors

Other operation errors

Number of other errors

 

<H3C> display nqa history administrator icmp

    NQA entry(admin administrator, tag icmp) history record:

    Index     Response    Status      LastRC    Time

      1            1         1           0      2005-11-02 16:28:55.0

      2            1         1           0      2005-11-02 16:28:55.0

      3            1         1           0      2005-11-02 16:28:55.0

      4            1         1           0      2005-11-02 16:28:55.0

      5            1         1           0      2005-11-02 16:28:55.0

Table 1-2 display nqa history command output description

Field

Description

Response

Round trip test time in milliseconds, or the timeout time. 0 means the test fails.

Status

Test result value

LastRC

Receive the last response code based on the implementation ways. With ICMP echo enabled, if the system receives ICMP response which includes ICMP_ECHOREPLY(0), the probe has succeeds.

Time

Test time

 

Table 1-3 Description of the status value in the NQA history records

Status value

Description

1

Response received

2

Unknown error, (for example, the socket read error)

3

System internal error

4

Timeout waiting for response

 

1.1.8  frequency

Syntax

frequency interval

undo frequency

View

NQA test group view

Parameters

interval: Automatic test interval, in the range 0 to 65535 seconds.

Description

Use the frequency command to configure the automatic test interval.

Use the undo frequency command to cancel the automatic test.

By default, the automatic test interval is 0 seconds, that is, the system does not perform the automatic test.

If the interval is greater than 0, the system performs one automatic test at the configured interval.

 

&  Note:

In the process of test, parameters in the test group cannot be changed, except the brief description of the operations and the condition of sending Trap information to the network management system.

 

Examples

# Set the automatic test interval to 10 seconds.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] frequency 10

1.1.9  history-records

Syntax

history-records number

undo history-records

View

NQA test group view

Parameters

number: Number of test results which can be stored in the history record, in the range 0 to 50.

Description

Use the history-records command to configure the number of test results that can be stored in the history record.

Use the undo history-records command to restore the default value.

By default, 50 test results can be stored in the history record.

 

&  Note:

When this command is executed, the switch checks the redundant history records and deletes them. Example: If the configuration allows 30 test results to be stored in the history record while there are 50 test results in the test group, the switch deletes the oldest 20 test results.

 

Examples

# Set the number of test results stored in the history records to 10.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] history-records 10

1.1.10  nqa

Syntax

nqa administrator-name test-tag

undo nqa administrator-name test-tag

View

System view

Parameters

administrator-name: Name of the test administrator, 1 to 32 characters long.

test-tag: Tag of the test operation, 1 to 32 characters long, and including no “-” symbols.

Description

Use the nqa command to create an NQA test group (if not available). You will enter the NQA test group view after this command is executed.

Use the undo nqa command to delete an NQA test group. At the same time, the test will be stopped, and the history record will be deleted.

Note that:

l           You can perform the test operation only after creating a test group.

l           You can create a maximum of 30 test groups.

Examples

# Create an NQA test group. Its name is administrator and its test tag is icmp.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa administrator icmp

1.1.11  nqa-agent enable

Syntax

nqa-agent enable

undo nqa-agent enable

View

System view

Parameters

None

Description

Use the nqa-agent enable command to enable the NQA client function.

Use the undo nqa-agent enable command to disable the NQA client function.

You can perform test operations only after you enable the NQA client function.

Examples

# Enable the NQA client.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

1.1.12  nqa-agent max-requests

Syntax

nqa-agent max-requests max-number

undo nqa-agent max-requests

View

System view

Parameters

max-number: Maximum Number of test operations enabled simultaneously, in the range 1 to 5.

Description

Use the nqa-agent max-requests command to set the maximum number of test operations that can be enabled simultaneously.

Use the undo nqa-agent max-requests command to restore the default value.

By default, a maximum of 5 test operations can be enabled simultaneously.

 

&  Note:

If the configured value is smaller than the number of enabled test groups, the current test is not stopped.

 

Examples

# Configure that the system can enable a maximum of 4 test operations simultaneously.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa-agent max-requests 4

1.1.13  probe-failtimes

Syntax

probe-failtimes times

undo probe-failtimes

View

NQA test group view

Parameters

times: Number of times of constant probe failures, in the range 1 to 15.

Description

Use the probe-failtimes command to set the number of consecutive probe failures after which NQA will send the Trap information to the network management system.

Use the undo probe-failtimes command to restore the default value.

By default, the system sends the Trap information to the network management system after one probe failure in an NQA test.

 

&  Note:

For the concept of test and probe, note the following content:

l      In each probe, the system sends only one packet.

l      One test may include multiple probes. The test succeeds as long as there is one successful probe.

l      The probe failure counter will be reset either after a test is finished or a probe succeeds. In other words, the times set in this command is only valid for a single test.

 

Related commands: test-failtimes.

Examples

# Set that the system sends Trap information after three consecutive probe failures in an NQA test.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] probe-failtimes 3

1.1.14  sendpacket passroute

Syntax

sendpacket passroute

undo sendpacket passroute

View

NQA test group view

Parameters

None

Description

Use the sendpacket passroute command to assume the connection mode between the destination address and the device which enables the test as direct connection mode. The destination and the device are directly connected without any layer 3 devices in between.

Use the undo sendpacket passroute command to cancel this assumption.

By default, no such assumption

 

&  Note:

l      If you assume the connection mode as direct connection mode, actually it equals to set the TTL to 1.

l      If you assume the connection mode as direct mode, but set the TTL value at the same time, then the TTL value does not take effect. This value takes effect when you cancel the configuration on the connection mode.

 

Examples

# Set that the system assumes the connection mode as direct connection when sending the ICMP packet.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] sendpacket passroute

1.1.15  send-trap

Syntax

send-trap { all | { probefailure | testcomplete | testfailure } * }

undo send-trap { all | { probefailure | testcomplete | testfailure } * }

View

NQA test group view

Parameters

probefailure: Sends the Trap information to the network management system when the probe fails and the corresponding filter condition is satisfied.

testcomplete: Sends the Trap information to the network management system when the test is finished.

testfailure: Sends the Trap information to the network management system when the test fails and the corresponding filter condition is satisfied.

all: Sends the Trap information to the network management system when any of the above conditions happens.

Description

Use the send-trap command to configure the conditions of sending Trap information to the network management system.

Use the undo send-trap command to cancel the configured the conditions of sending Trap information.

By default, no Trap information is sent to the network management system.

The Trap information includes alert message or prompt message. The purpose of sending the trap information is to remind the administrator to manage the system.

Related commands: probe-failtimes, test-failtimes.

Examples

# Configure the condition of sending Trap information as testcomplete.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] send-trap testcomplete

1.1.16  source-interface

Syntax

source-interface interface-type interface-number

undo source-interface

View

NQA test group view

Parameters

interface-type: Type of interface.

interface-number: Number of interface.

Description

Use the source-interface command to configure the source interface for sending test packet.

Use the undo source-interface command to disable the configured source interface.

By default, no source interface for sending test packet is configured.

 

&  Note:

The source interface must be a Layer 3 interface. Otherwise, the system stops the test for not finding the corresponding IP address. If a source IP address is configured, no IP address of the source interface will be used. But the system still checks whether the interface is a Layer 3 interface or not as the ordinary ping operation does.

 

Examples

# Configure the VLAN-interface 60 as the source interface for sending test packet.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] source-interface Vlan-interface 60

1.1.17  source-ip

Syntax

source-ip ip-address

undo source-ip

View

NQA test group view

Parameters

ip-address: Source IP address of the test.

Description

Use the source-ip command to configure the source IP address of the test.

Use the undo source-ip command to cancel the configured source IP address.

By default, no source IP address is configured. The system uses the IP address of the source interface as the source IP address.

Examples

# Set the source IP address of this test to 192.168.60.60.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] source-ip 192.168.60.60

1.1.18  test-enable

Syntax

test-enable

undo test-enable

View

NQA test group view

Parameters

None

Description

Use the test-enable command to enable NQA test.

Use the undo test-enable command to disable NQA test.

 

&  Note:

l      The test result cannot be automatically displayed after the NQA test is executed. You need to use the display nqa command to display the test result.

l      When the system is testing, parameters in the test group cannot be changed except the brief description of the operation and the condition of sending Trap information to the network management system.

 

Examples

# Execute the NQA test.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] test-enable

1.1.19  test-failtimes

Syntax

test-failtimes times

undo test-failtimes

View

NQA test group view

Parameters

times: Number of constant test failures, in the range 1 to 15.

Description

Use the test-failtimes command to set the number of consecutive test failures after which the system will send the Trap information to the network management system.

Use the undo test-failtimes command to restore the default value.

By default, the system sends the Trap information to the network management system after one NQA test failure.

Related commands: probe-failtimes.

Examples

# Set that the system sends Trap information after three consecutive probe failures in an NQA test.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] test-failtimes 3

1.1.20  test-type

Syntax

test-type type

View

NQA test group view

Parameters

type: Type of test, currently it is only the icmp type.

Description

Use the test-type command to configure the test type.

By default, the test type is icmp.

 

&  Note:

The test type is required, so no undo command is provided.

 

Examples

# Specify the test type as icmp.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] test-type icmp

1.1.21  timeout

Syntax

timeout time

undo timeout

View

NQA test group view

Parameters

time: Timeout time, in the range 1 to 60 seconds.

Description

Use the timeout command to configure the timeout time of the test operation.

Use the undo timeout command to restore the default value.

By default, the timeout time of test operation is three seconds

Examples

# Set the timeout time to 10 seconds.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] timeout 10

1.1.22  tos

Syntax

tos value

undo tos

View

NQA test group view

Parameters

value: TOS (type of service) value in the NQA test packet header, in the range 0 to 255.

Description

Use the tos command to configure the TOS value in the NQA test packet header.

Use the undo tos command to restore the default value.

By default, the TOS value in the NQA test packet header is 0, that is, no special service is specified.

This parameter equals to the “-v” parameter in the ping command of the Windows operation system.

 

&  Note:

See “RFC 1349” for detailed explanations of the service types.

 

Examples

# Configure the TOS value in the NQA test packet header to 4 (representing the highest reliability).

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] tos 4

1.1.23  ttl

Syntax

ttl number

undo ttl

View

NQA test group view

Parameters

number: Maximum number of hops that an NQA ICMP test packet can pass in the network, in the range of 1 to 255. This parameter equals to the “-i” parameter in the ping command of the Windows operation system.

Description

Use the ttl command to configure the maximum number of hops that an NQA ICMP test packet can pass in the network, that is, the “life time” of the NQA packet.

Use the undo ttl command to restore the default value.

By default, the maximum number of hops that an NQA ICMP test packet can pass in the network is 20.

Examples

# Configure the maximum number of hops that an NQA test packet can pass in the network to 16.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] ttl 16

1.1.24  vpn-instance

Syntax

vpn-instance name

undo vpn-instance

View

NQA test group view

Parameters

name: Name of the specified VPN instance, a string of up to 19 characters.

Description

Use the vpn-instance command to set the name of the VPN instance for the test.

Use the undo vpn-instance command to cancel the name of the VPN instance for the test.

By default, no information of the VPN instance is set.

 

&  Note:

You must set the name for VPN instance. Otherwise, the test will fail for the system can not find the corresponding VPN index.

 

Examples

# Specify the name of the VPN instance for the test as vpn1.

<H3C> system-view

System View: return to User View with Ctrl+Z.

[H3C] nqa-agent enable

[H3C] nqa administrator icmp

[H3C-nqa-administrator-icmp] vpn-instance vpn1

 

  • Cloud & AI
  • InterConnect
  • Intelligent Computing
  • Security
  • SMB Products
  • Intelligent Terminal Products
  • Product Support Services
  • Technical Service Solutions
All Services
  • Resource Center
  • Policy
  • Online Help
All Support
  • Become A Partner
  • Partner Policy & Program
  • Global Learning
  • Partner Sales Resources
  • Partner Business Management
  • Service Business
All Partners
  • Profile
  • News & Events
  • Online Exhibition Center
  • Contact Us
All About Us
新华三官网