H3C description命令怎么用？

在网络设备的日常管理和维护中，清晰、规范的配置注释是提升效率、减少错误的关键，H3C（新华三）设备的 description 命令（常简写为 desc）正是为此而生的核心工具，它允许网络管理员为各种配置对象（如接口、VLAN、路由策略、ACL条目等）添加描述性文本,极大地提升了配置的可读性和可管理性。

description 命令的核心作用

1. 增强可读性： 为复杂的配置条目添加人类可读的说明，使配置本身“自解释”，看到一个接口描述为 desc To-Core-Switch-G0/0/24 远比只看一个接口编号 GigabitEthernet1/0/1 直观得多。
2. 简化故障排查： 当网络出现问题时，清晰的描述能帮助管理员快速定位相关配置段落的用途和关联设备/链路,缩短排障时间。
3. 提升团队协作： 统一的描述规范让不同管理员都能轻松理解配置意图，减少沟通成本,避免因理解偏差导致的误操作。
4. 辅助文档化： 配置中的描述本身就是一种轻量级的实时文档,与外部文档相辅相成。
5. 标识特定用途： 标记接口连接对象、VLAN的业务类型、ACL条目的具体目的、路由策略的应用场景等。

description 命令的基本语法

description 命令的使用语法非常直观,通常遵循以下模式：

[object-type] [object-identifier] description text

或者进入对象视图后使用：

[H3C] interface gigabitethernet 1/0/1  // 进入接口GigabitEthernet1/0/1视图
[H3C-GigabitEthernet1/0/1] description text  // 在该接口下配置描述

• [object-type]： 要添加描述的对象类型，常见的有：
  • interface (或具体接口类型如 gigabitethernet, vlan-interface, loopback, bridge-aggregation 等)
  • vlan
  • route-policy
  • acl (通常用于ACL中的规则 rule)
  • ospf / isis / bgp (在进程视图下描述整个路由进程)
  • user-interface (如Console, VTY线路)
  • local-user (本地用户)
  • 等等。
• [object-identifier]： 具体对象的标识符，例如接口名 GigabitEthernet1/0/1，VLAN ID 10，路由策略名 PERMIT-LOCAL，ACL编号 3000 等。
• text： 您要添加的描述文本，文本通常需要用英文双引号 括起来，特别是当文本中包含空格、特殊字符（如 , , _ 通常可以，但 , &, 等需谨慎）或需要以数字开头时，如果文本是连续的字母数字组合（无空格），有时可以省略引号，但强烈建议始终使用双引号以保证兼容性和避免歧义。

description 命令的常见应用场景与示例

1. 为物理/逻辑接口添加描述：

   • 场景： 标记接口连接的设备、端口、链路类型或用途。

   • 示例：

     [H3C] interface gigabitethernet 1/0/1
     [H3C-GigabitEthernet1/0/1] description "Uplink to Core-Switch G1/0/24"
     [H3C-GigabitEthernet1/0/1] quit
     [H3C] interface vlan-interface 10
     [H3C-Vlan-interface10] description "Server_VLAN_10.10.10.0/24"
     [H3C-Vlan-interface10] quit
     [H3C] interface loopback 0
     [H3C-LoopBack0] description "Router-ID and Management"
     [H3C-LoopBack0] quit
     [H3C] interface bridge-aggregation 1
     [H3C-Bridge-Aggregation1] description "LinkAgg to Access-Switch01"
     [H3C-Bridge-Aggregation1] quit

2. 为VLAN添加描述：

   • 场景： 说明VLAN对应的部门、业务类型或地理位置。

   • 示例：

     [H3C] vlan 20
     [H3C-vlan20] description "Finance_Department"
     [H3C-vlan20] quit
     [H3C] vlan 30
     [H3C-vlan30] description "Guest_WiFi_VLAN"
     [H3C-vlan30] quit

3. 为路由策略添加描述：

   • 场景： 说明策略的目的、匹配条件和应用动作。
   • 示例：

     [H3C] route-policy PERMIT-LOCAL permit node 10
     [H3C-route-policy-PERMIT-LOCAL-10] description "Permit Local Routes (Direct/Static)"
     [H3C-route-policy-PERMIT-LOCAL-10] if-match ip address prefix-list LOCAL-NETS
     [H3C-route-policy-PERMIT-LOCAL-10] quit

4. 为ACL规则添加描述：

   • 场景： 详细说明每条ACL规则允许或拒绝的流量类型、源/目的、服务等。
   • 示例：

     [H3C] acl advanced 3000
     [H3C-acl-ipv4-adv-3000] rule 5 permit ip source 10.1.1.0 0.0.0.255 destination 192.168.1.10 0
     [H3C-acl-ipv4-adv-3000] rule 5 description "Allow HR-Subnet to HR-Server"
     [H3C-acl-ipv4-adv-3000] rule 10 deny tcp destination-port eq 3389
     [H3C-acl-ipv4-adv-3000] rule 10 description "Block External RDP Access"
     [H3C-acl-ipv4-adv-3000] quit

5. 为路由协议进程添加描述：

   • 场景： 标记该OSPF/IS-IS/BGP进程的用途或区域。
   • 示例：

     [H3C] ospf 100
     [H3C-ospf-100] description "Backbone Area OSPF Process"
     [H3C-ospf-100] quit

6. 为管理线路/本地用户添加描述：

   • 场景： 说明Console/VTY线路的用途或本地用户的角色。

   • 示例：

     [H3C] user-interface vty 0 4
     [H3C-ui-vty0-4] description "Remote Management via SSH"
     [H3C-ui-vty0-4] quit
     [H3C] local-user admin
     [H3C-luser-manage-admin] description "Network Administrator Account"
     [H3C-luser-manage-admin] quit

查看配置的描述信息

配置好 description 后,您可以通过以下常用命令查看：

1. display current-configuration / display saved-configuration： 查看当前运行配置或已保存的启动配置,描述信息会显示在对应配置对象的下面。
2. display interface [interface-type interface-number]： 查看指定接口的详细信息，输出中会包含 Description: ... 行。
3. display vlan [vlan-id]： 查看指定VLAN的详细信息,包含描述。
4. display route-policy [name]： 查看路由策略的详细信息,包含节点描述。
5. display acl [acl-number | name acl-name]： 查看ACL配置,包含规则描述。
6. 进入对象视图后直接查看： 进入接口、VLAN、路由策略节点等视图后，直接输入 display this 会显示该视图下的当前配置，包含 description 行。

修改或删除描述信息

• 修改描述： 直接在对应的配置对象视图下重新输入 description "new text" 命令,新的描述文本会覆盖旧的描述。
• 删除描述： 在对应的配置对象视图下，使用 undo description 命令。

  [H3C] interface gigabitethernet 1/0/1
  [H3C-GigabitEthernet1/0/1] undo description
  [H3C-GigabitEthernet1/0/1] quit

使用 description 命令的最佳实践与注意事项

1. 保持一致性： 在整个网络或团队内部制定并遵循统一的描述规范（如命名约定、缩写规则），接口描述统一使用 To-[设备名]-[接口号] 格式。
2. 清晰简洁： 描述应准确反映对象的用途或连接关系，避免过于冗长或模糊不清,在保证清晰的前提下尽量简洁。
3. 包含关键信息： 对于接口，通常包含对端设备名+端口号、链路类型（如 Uplink, Downlink, Trunk, Access）、VLAN ID 或 IP 网段等，对于策略和ACL,说明其目的。
4. 使用英文和标准符号： 推荐使用英文描述，避免潜在的字符编码问题，使用 , _, 等标准分隔符增强可读性（如 Server-Farm_VLAN10/24）。
5. 及时更新： 当网络拓扑或配置发生变化时，务必同步更新相关的描述信息，保持描述的时效性和准确性,过时的描述比没有描述更糟糕。
6. 利用双引号： 强烈建议始终将描述文本用英文双引号 括起来，这是最安全、兼容性最好的做法,能有效避免因空格或特殊字符导致的命令解析错误。
7. 长度限制： 注意不同对象或不同H3C设备型号/软件版本可能对描述文本长度有不同限制（通常几十到上百个字符）,超出限制的部分会被截断。
8. 非配置性： description 命令添加的文本仅用于注释，不会影响设备的功能性配置或数据转发行为,它纯粹是为了方便管理员阅读和理解配置。
9. 保存配置： 添加、修改或删除描述后，务必记得使用 save 命令保存配置,否则设备重启后这些描述信息将丢失。

H3C 设备的 description (desc) 命令是一个简单却极其强大的网络运维工具，它通过为配置对象添加清晰、规范的描述性文本，显著提升了网络配置的可读性、可管理性和可维护性，是网络管理员进行高效故障排查、团队协作和网络文档化不可或缺的手段，养成在配置关键对象时添加描述的良好习惯，是专业网络运维的重要体现，能为您和您的团队节省大量时间和精力，遵循最佳实践，善用 description 命令，让您的网络配置“会说话”。

引用说明：

• 基于 H3C Comware V7 网络操作系统命令行参考手册中关于 description 命令的通用描述和常见应用场景整理而成，具体命令语法和支持的对象类型可能因设备型号和软件版本略有差异，请以设备实际支持情况为准，建议查阅对应设备型号和软件版本的官方配置指南获取最精确信息：
  • H3C 官方网站支持中心：https://www.h3c.com/cn/Service/Document_Center/
  • (搜索 “S6850 配置指南” 或 “Comware V7 命令参考”)