- Table of Contents
- Related Documents
-
Title | Size | Download |
---|---|---|
02-ANCP commands | 105.81 KB |
Contents
ANCP commands
aging-time
Use aging-time to configure the aging time for DSL entries.
Use undo aging-time to restore the default.
Syntax
aging-time value
undo aging-time
Default
The aging time for DSL entries is 150 seconds.
Views
ANCP neighbor view
Predefined user roles
network-admin
Parameters
value: Configures the aging time, in the range of 0 to 65535 seconds. If you set the value to 0, the system deletes a DSL entry once the DSL goes down.
Usage guidelines
IMPORTANT: If an ANCP neighbor needs to reboot the DSL after receiving a service profile, the DSL entry aging time configured for the neighbor must be long enough for the neighbor to complete the reboot. |
The ANCP server records DSL information in DSL entries. If a user on a DSL goes offline, the server will remove the corresponding DSL entry when its aging timer expires.
Examples
# Configure the DSL entry aging time as 100 seconds for ANCP neighbor test1.
<Sysname> system-view
[sysname] ancp neighbor test1
[sysname-ancp-neighbor-test1] aging-time 100
ancp access-loop-configure
Use ancp access-loop-configure to assign a service profile to a DSL from the ANCP server.
Syntax
ancp access-loop-configure circuit-id circuit-id service-profile profile-name [ timeout time-value ]
Views
System view
Predefined user roles
network-admin
Parameters
circuit-id circuit-id: Specifies a DSL ID, a case-sensitive string of 1 to 63 characters. You can use display ancp access-loop to view the ID of a DSL.
service-profile profile-name: Specifies a service profile by its name, a case-sensitive string of 1 to 64 characters.
timeout time-value: Configures the timeout timer for the client to respond, in the range of 0 to 60 seconds. The default timeout timer is 5 seconds. If you set the timer to 0, the server does not wait for the client to respond.
Usage guidelines
This command assigns a service profile to a DSL from the server. The service profile must already exist on the client.
Examples
# Assign service profile text-profile to DSL Dslam1/1:100 and set the timeout timer to 0.
<Sysname> system-view
[Sysname] ancp access-loop-configure circuit-id Dslam1/1:100 service-profile text-profile timeout 0
# Assign service profile text-profile to DSL Dslam1/1:100 and use the default timeout timer. (The DSL does not exist.)
<Sysname> system-view
[Sysname] ancp access-loop-configure circuit-id Dslam1/1:100 service-profile text-profile
Issuing service profile name text-profile for Dslam1/1:100. Please wait…
Access line Dslam1/1:100 doesn’t exist.
# Assign service profile text-profile to DSL Dslam1/1:100 and set the timeout timer to 10 seconds. (Service profile assignment succeeds.)
<Sysname> system-view
[Sysname] ancp access-loop-configure circuit-id Dslam1/1:100 service-profile text-profile timeout 10
Issuing service profile name text-profile for Dslam1/1:100. Please wait…
Issued the service profile name successfully.
Status info: xxxxxxxxxxxxxxxxxxxx
# Assign service profile text-profile to DSL Dslam1/1:100 and use the default timeout timer. (Service profile assignment fails.)
<Sysname> system-view
[Sysname] ancp access-loop-configure circuit-id Dslam1/1:100 service-profile text-profile
Issuing service profile name text-profile for Dslam1/1:100. Please wait…
Failed to issue the service profile name. Operation timed out.
Status info: xxxxxxxxxxxxxxxxxxxx
Table 1 Command output
Field |
Description |
Status info: xxxxxxxxxxxxxxxxxxxx |
Status information sent by the client. This field varies by device model. If the client does not send status information, xxxxxxxxxxxxxxxxxxxx is displayed. |
Failed to issue the service profile name |
The service profile was not assigned. |
Out of resources |
The client does not have sufficient resources. |
Request message type not implemented |
The system does not support the request message type. |
Related commands
display ancp access-loop
ancp enable
Use ancp enable to enable the ANCP server.
Use undo ancp enable to disable the ANCP server.
Syntax
ancp enable
undo ancp enable
Default
The ANCP server is disabled.
Views
System view
Predefined user roles
network-admin
Usage guidelines
You must enable the ANCP server. If the ANCP server is disabled, the system terminates all ANCP adjacencies and closes TCP port 6068.
Examples
# Enable the ANCP server.
<Sysname> system-view
[Sysname] ancp enable
Related commands
ancp source-interface
source-interface
ancp neighbor
Use ancp neighbor to create an ANCP neighbor and enter its view, or enter the view of an existing ANCP neighbor.
Use undo ancp neighbor to delete the ANCP neighbor.
Syntax
ancp neighbor neighbor-name
undo ancp neighbor neighbor-name
Default
No ANCP neighbors exist.
Views
System view
Predefined user roles
network-admin
Parameters
neighbor-name: Specifies the name of the ANCP neighbor, a case-sensitive string of 1 to 31 characters.
Usage guidelines
You can create multiple ANCP neighbors, and configure parameters for each neighbor.
If you delete an ANCP neighbor, the system deletes information about the neighbor, and closes the ANCP adjacency and TCP connection to the neighbor.
Examples
# Create ANCP neighbor test1 and enter its view.
<Sysname> system-view
[sysname] ancp neighbor test1
[sysname-ancp-neighbor-test1]
ancp oam
Use ancp oam to start an ANCP OAM test for a DSL.
Syntax
ancp oam [ count test-counter | timeout time-value ] * access-loop circuit-id
Views
System view
Predefined user roles
network-admin
Parameters
count test-counter: Configures the number of OAM attempts, in the range of 1 to 32. The default number is 5.
timeout time-value: Configures the timeout timer for the client to respond, in the range of 1 to 60 seconds. The default timeout timer is 5 seconds.
access-loop circuit-id: Specifies the DSL ID, a case-sensitive string of 1 to 63 characters. You can use display ancp access-loop to view the ID of a DSL.
Usage guidelines
This command requests the client to check the status of the specified DSL before the number of test attempts reaches the maximum. The ANCP OAM test fails if the client does not send the test result to the server before the timer expires.
Examples
# Start an ANCP OAM test for a DSL. (The DSL does not exist.)
<Sysname> system-view
[sysname] ancp oam count 5 timeout 5 access-loop Dslam1/1:100
OAM testing Dslam1/1:100. Please wait…
Access line Dslam1/1:100 doesn't exist.
# Start an ANCP OAM test for a DSL. (The OAM test succeeds.)
<Sysname> system-view
[sysname] ancp oam count 5 timeout 5 access-loop Dslam1/1:100
OAM testing Dslam1/1:100. Please wait…
OAM test succeeded.
Status info: xxxxxxxxxxxxxxxxxxxx
# Start an ANCP OAM test for a DSL. (The OAM test fails.)
<Sysname> system-view
[sysname] ancp oam count 5 timeout 5 access-loop Dslam2/1:100
OAM testing Dslam2/1:100. Please wait…
OAM test failed. Loopback test timed out
Status info: xxxxxxxxxxxxxxxxxxxx
Table 2 Command output
Field |
Description |
Status info: xxxxxxxxxxxxxxxxxxxx |
Status information sent by the client. This field varies by device model. If the client does not send status information, xxxxxxxxxxxxxxxxxxxx is displayed. |
DSL access line status showtime |
The DSL status is SHOWTIME. For more information about the DSL status, see ITU-T G.993.2. |
DSL access line status idle |
The DSL status is IDLE. For more information about the DSL status, see ITU-T G.993.2. |
DSL access line status silent |
The DSL status is SILENT. For more information about the DSL status, see ITU-T G.993.2. |
DSL access line status training |
The DSL status is TRAINING. For more information about the DSL status, see ITU-T G.993.2. |
Related commands
display ancp access-loop
ancp session interval
Use ancp session interval to configure the adjacency timer for sending SYN packets.
Use undo ancp session interval to restore the default.
Syntax
ancp session interval interval
undo ancp session interval
Default
The adjacency timer is 25 seconds.
Views
System view
Predefined user roles
network-admin
Parameters
interval: Configures the adjacency timer, in the range of 1 to 25 seconds.
Usage guidelines
The ANCP server and the ANCP client exchange SYN packets to negotiate adjacency timers. The two ends use the longer adjacency timer to send SYNACK and ACK packets.
If you modify the adjacency timer after an ANCP adjacency is established, the change does not take effect immediately. The change takes effect after the ANCP adjacency is disconnected and adjacency timers are negotiated again.
Examples
# Configure the adjacency timer as 15 seconds.
<Sysname> system-view
[sysname] ancp session interval 15
ancp session retransmit
Use ancp session retransmit to configure the maximum number of retransmission attempts for SYN and SYNACK packets.
Use undo ancp session retransmit to restore the default.
Syntax
ancp session retransmit retransmit-value
undo ancp session retransmit
Default
The maximum number of retransmission attempts for SYN and SYNACK packets is 10.
Views
System view
Predefined user roles
network-admin
Parameters
retransmit-value: Configures the maximum number of retransmission attempts, in the range of 3 to 255.
Usage guidelines
The ANCP server retransmits a SYN or SYNACK message if it does not receive the message from the client before the adjacency timer expires. If the client does not respond after the retransmission attempts reach the maximum, the server closes the TCP connection.
Examples
# Configure a maximum of 100 retransmission attempts.
<Sysname> system-view
[sysname] ancp session retransmit 100
ancp source-interface
Use ancp source-interface to configure a global source interface.
Use undo ancp source-interface to restore the default.
Syntax
ancp source-interface loopback interface-number
undo ancp source-interface
Default
No global source interface is configured.
Views
System view
Predefined user roles
network-admin
Parameters
loopback interface-number: Specifies a loopback interface as the global source interface.
Usage guidelines
You must configure one global source interface for all adjacencies or one neighbor-specific source interface for each adjacency. The global source interface applies to all adjacencies. The ANCP server prefers the neighbor-specific source interface over the global source interface when it communicates with the specified neighbor.
The ANCP server uses one of the following addresses as the source IP address for TCP packets sent to an ANCP neighbor:
· The primary IPv4 address of the source interface.
· The first IPv6 global unicast address of the source interface.
If you delete the global source interface, the device closes the TCP port 6068 for neighbors without a neighbor-specific source interface. If you change the global source interface, the device uses the IP address of the new source interface. The delete or change operation does not affect existing ANCP adjacencies.
Examples
# Configure loopback 100 as the global source interface.
<Sysname> system-view
[sysname] ancp source-interface loopback 100
Related commands
ancp enable
source-interface
display ancp access-loop
Use display ancp access-loop to display information about DSL entries.
Syntax
display ancp access-loop [ circuit-id circuit-id | neighbor neighbor-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
circuit-id circuit-id: Specifies a DSL ID, a case-sensitive string of 1 to 63 characters. You can use display ancp access-loop to view the ID of a DSL. If you specify a DSL, this command displays detailed information about the specified DSL entry. If you do not specify a DSL, this command displays brief information about all DSL entries.
neighbor neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you specify an ANCP neighbor, this command displays brief information about DSL entries for the specified ANCP neighbor. If you do not specify an ANCP neighbor, this command displays brief information about DSL entries for all ANCP neighbors.
Examples
# Display general information about DSL entries for all ANCP neighbors.
<Sysname> display ancp access-loop
Total entries: 1
Neighbor name Peer ID Circuit ID State
bras 0001-0002-0003 circuit4:430 UP
# Display detailed information about the entry of a specified DSL.
<Sysname> display ancp access-loop circuit-id circuit4:430
Neighbor name : bras
Circuit ID : circuit4:430
Remote ID : -
Peer ID : 0001-0002-0003
DSL type : ADSL1
Actual data rate upstream : 64 kbps
Actual data rate downstream : 128 kbps
Min data rate upstream : 32 kbps
Min data rate downstream : 32 kbps
Attainable data rate upstream : 1024 kbps
Attainable data rate downstream : 8192 kbps
Max data rate upstream : 1024 kbps
Max data rate downstream : 8192 kbps
Min low power data rate upstream : 32 kbps
Min low power data rate downstream : 32 kbps
Max delay upstream : 20 s
Max delay downstream : 8192 s
Actual delay upstream : 20 s
Actual delay downstream : 20 s
Data link : ETHERNET
Encapsulation 1 : Untagged Ethernet
Encapsulation 2 : NA
# Display general information about DSL entries for a specified ANCP neighbor.
<Sysname> display ancp access-loop neighbor dslam1
Total entries: 1
Neighbor name Peer ID Circuit ID State
dslam1 0001-0002-0003 001882362CFF eth 0/3/0/2:6 UP
Table 3 Command output
Field |
Description |
Peer ID |
ANCP neighbor ID, which is the MAC address of the client. |
Circuit ID |
DSL ID. |
State |
DSL status: · UP. · DOWN. |
DSL type |
DSL type: · ADSL1. · ADSL2. · ADSL2+. · VDSL1. · VDSL2. · SDSL. · Other. |
Data link |
Data link type, which can only be ETHERNET. |
Encapsulation 1 |
Encapsulation 1 information: · NA—The packet does not contain encapsulation 1. · Untagged Ethernet—Ethernet packet without VLAN tags. · Single-tagged Ethernet—Ethernet packet with one VLAN tag. · Double-tagged Ethernet—Ethernet packet with two VLAN tags. |
Encapsulation 2 |
Encapsulation 2 information: · NA—The packet does not contain encapsulation 2. · IPoA LLC—IPoA packet based on logical link control. · IPoA Null—IPoA packet. |
Related commands
display ancp neighbor
Use display ancp neighbor to display information about ANCP neighbors.
Syntax
display ancp neighbor [ neighbor-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you specify an ANCP neighbor, this command displays detailed information for the specified ANCP neighbor. If you do not specify an ANCP neighbor, this command displays brief information for all ANCP neighbors.
Examples
# Display general information about all ANCP neighbors.
<Sysname> display ancp neighbor
Total entries: 2
Neighbor name Peer ID State Access loop number
default-neighbor - Unused 0
dslam1 0001-0002-0003 Used 3
# Display detailed information about the specified ANCP neighbor.
<Sysname> display ancp neighbor dslam1
Neighbor name : dslam1
Peer ID : 0001-0002-0003
Source interface : LoopBack1
Session message interval : 25 s
Session message retransmit : 255
Aging time : 150 s
State : Used
Peer IP : 1.1.1.1
Peer port : 8093
Neighbor capacities : discovery, line-cfg, oam
Negotiated interval : 25.0 s
Access loop number : 0
Table 4 Command output
Field |
Description |
Peer ID |
ANCP neighbor ID. |
State |
ANCP neighbor status: · Used—The server has established an adjacency with the ANCP client. · Unused—The server has not established an adjacency with the ANCP client. |
Peer IP |
IP address of the ANCP neighbor. |
Peer port |
TCP port of the ANCP neighbor. |
Neighbor capacities |
ANCP neighbor capabilities: · discovery—Dynamic topology discovery. · line-cfg—DSL configuration. · oam—OAM test. |
Access loop number |
Total DSLs on the ANCP neighbor. |
Related commands
reset ancp neighbor
display ancp statistics
Use display ancp statistics to display ANCP neighbor statistics.
Syntax
display ancp statistics [ neighbor neighbor-name ]
Views
Any view
Predefined user roles
network-admin
network-operator
Parameters
neighbor neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you do not specify an ANCP neighbor, this command displays statistics for all ANCP neighbors.
Examples
# Display statistics for all ANCP neighbors.
<Sysname> display ancp statistics
Received ack packets : 1311
Received syn packets : 0
Received synack packets : 2
Received reset ack packets : 0
Received port up packets : 1
Received port down packets : 0
Received oam packets : 0
Received access loop config packets : 0
Received update packets : 0
Received generic response packets : 0
Received unknown packets : 0
Dropped packets : 0
Sent ack packets : 1311
Sent syn packets : 6
Sent synack packets : 0
Sent reset ack packets : 0
Sent oam packets : 0
Sent access loop config packets : 0
Sent generic response packets : 0
Packets failing to be sent : 0
Adjacency up : 2
Adjacency failed : 0
Adjacency down : 1
# Display statistics for the specified ANCP neighbor.
<Sysname>display ancp statistics neighbor dslam1
Received ack packets : 981
Received syn packets : 0
Received synack packets : 1
Received reset ack packets : 0
Received port up packets : 1
Received port down packets : 0
Received oam packets : 0
Received access loop config packets : 0
Received update packets : 0
Received generic response packets : 0
Received unknown packets : 0
Dropped packets : 0
Sent ack packets : 981
Sent syn packets : 1
Sent synack packets : 1
Sent reset ack packets : 0
Sent oam packets : 0
Sent access loop config packets : 0
Sent generic response packets : 0
Packets failing to be sent : 0
Table 5 Command output
Field |
Description |
Received reset ack packets |
Number of received RSTACK packets. RSTACK messages are used for resetting ANCP adjacencies. |
Received port up packets |
Number of received Port Up packets. When a DSL is up, the client sends the server a Port Up message containing the DSL parameters. |
Received port down packets |
Number of received Port Down packets. When a DSL is down, the client sends the server a Port Down message informing the server to delete the DSL parameters. |
Received access loop config packets |
Number of received DSL configuration packets. |
Received update packets |
Number of received Update packets. The client sends an Update message to the server when new BRASs enter the network. The Update message contains the total number of BRASs in the network and the total number of DSLs connecting to the client. |
Received generic response packets |
Number of received Generic Response packets. A Generic Response message is sent as a response to a request message or sent because of errors. |
Sent access loop config packets |
Number of transmitted DSL configuration packets. |
Related commands
reset ancp statistics
peer-id
Use peer-id to configure an ANCP neighbor ID.
Use undo peer-id to restore the default.
Syntax
peer-id peer-id
undo peer-id
Default
No ANCP neighbor ID is configured.
Views
ANCP neighbor view
Predefined user roles
network-admin
Parameters
peer-id: Specifies an ANCP neighbor ID, in the format of H-H-H. The ID is the MAC address of a client.
Usage guidelines
The ANCP server uses ANCP neighbor IDs to identify ANCP clients. If the MAC address of a client does not match any ANCP neighbor ID, the server closes the TCP connection to the client.
A neighbor ID uniquely identifies an ANCP neighbor. If you remove a neighbor ID, the server closes the TCP connection to the corresponding neighbor.
Examples
# Configure 1-2-3 as the ID of ANCP neighbor test1.
<Sysname> system-view
[sysname] ancp neighbor test1
[sysname-ancp-neighbor-test1] peer-id 1-2-3
Related commands
ancp neighbor
reset ancp access-loop
Use reset ancp access-loop to delete DSL entries.
Syntax
reset ancp access-loop [ circuit-id circuit-id | neighbor neighbor-name ]
Views
User view
Predefined user roles
network-admin
Parameters
circuit-id circuit-id: Specifies the DSL ID, a case-sensitive string of 1 to 63 characters. You can use display ancp access-loop to view the ID of a DSL. If you do not specify a DSL, this command deletes all DSL entries.
neighbor neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you do not specify an ANCP neighbor, this command deletes DSL entries for all ANCP neighbors.
Examples
# Delete the entry for DSL 0001-0002-0003 eth 1/162 3:11.
<Sysname> reset ancp access-loop circuit-id “0001-0002-0003 eth 1/162 3:11”
Related commands
display ancp access-loop
reset ancp neighbor
Use reset ancp neighbor to clear ANCP neighbor information and close TCP connections.
Syntax
reset ancp neighbor [ neighbor-name ]
Views
User view
Predefined user roles
network-admin
Parameters
neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you do not specify an ANCP neighbor, this command clears information about all ANCP neighbors and closes all TCP connections.
Examples
# Clear information about ANCP neighbor dslam1 and close its TCP connection.
<Sysname> reset ancp neighbor dslam1
Deleting the neighbor and shutting down the TCP socket. Continue?[Y/N]y
Related commands
display ancp neighbor
reset ancp statistics
Use reset ancp statistics to clear ANCP neighbor statistics.
Syntax
reset ancp statistics [ neighbor neighbor-name ]
Views
User view
Predefined user roles
network-admin
Parameters
neighbor-name: Specifies an ANCP neighbor by its name, a case-sensitive string of 1 to 31 characters. If you do not specify an ANCP neighbor, this command removes statistics for all ANCP neighbors.
Examples
# Clear statistics for ANCP neighbor dslam1.
<Sysname> reset ancp statistics neighbor dslam1
Related commands
display ancp statistics
source-interface
Use source-interface to configure a source interface for a neighbor.
Use undo source-interface to restore the default.
Syntax
source-interface loopback interface-number
undo source-interface
Default
No source interface is configured for a neighbor.
Views
ANCP neighbor view
Predefined user roles
network-admin
Parameters
loopback interface-number: Specifies a loopback interface as the source interface for a neighbor.
Usage guidelines
You must configure one global source interface for all adjacencies or one neighbor-specific source interface for each adjacency. The ANCP server prefers the neighbor-specific source interface over the global source interface when it communicates with the neighbor.
The ANCP server uses one of the following addresses as the source IP address for TCP packets sent to an ANCP neighbor:
· The primary IPv4 address of the source interface.
· The first IPv6 global unicast address of the source interface.
If you delete a neighbor-specific source interface, and no global source interface exists, the device closes the TCP port 6068 for the neighbor. If you change the global source interface, the device uses the IP address of the new source interface. The delete or change operation does not affect existing ANCP adjacencies.
Examples
# Configure loopback 100 as the source interface for ANCP neighbor test1.
<Sysname> system-view
[sysname] ancp neighbor test1
[sysname-ancp-neighbor-test1] source-interface loopback 100
Related commands
ancp enable
ancp source-interface