首页/网络/网络设备配置速查/接口描述(description / 接口标注)
接口与链路73 条

接口描述(description / 接口标注)

接口描述是弱架构下最便宜的价值:对端设备名、用途、跳线类型写清楚,变更和排障时能省下大量 tracing 时间;三厂语法几乎一致。

网络设备配置速查网络更新于 2026-10-13

接口描述是什么

接口描述(description)是给端口写一段给人看的标注,写清「对端设备 + 对端端口 + 用途」。它不影响任何转发行为,却是弱架构环境里性价比最高的一笔投入:割接前核对、变更审计、半夜排障时,一眼就能确认这根线连到哪里,省掉大量顺着线缆 tracing 的时间。三家命令同名,语法几乎一致。

基本信息

适用设备全部设备(华为 VRP / H3C Comware / 思科 IOS)
配置命令description(三家同名),在接口视图下配置
删除命令华为/H3C undo description;思科 no description
查看方式思科 show interfaces description(带状态列的总览表);华为/H3C display this 或 display interface brief 的描述列
长度上限常见约 80 字符,超长会被截断

典型使用场景

  • 设备开局与割接:给每根互联线标注对端设备与端口,交接班不用再翻图
  • 变更前审计:确认要动的口到底连着什么,避免关错口
  • 故障定位:接口 up/down 告警时,直接从描述判断影响范围与责任方
  • 临时跳线留痕:跳线、测试线的临时用途写进描述,撤除时不会漏
  • 区分同服务多链路:如双上联两条线分别标注主/备编号,排障时能报准确位置

华为 VRP

华为 VRP
[Huawei-GigabitEthernet0/0/1] description To-SW-CORE-01 Gi0/0/24 Trunk
[Huawei-GigabitEthernet0/0/1] display this        # 确认已写入
! 删除:undo description
<Huawei> display interface brief | include Gi0/0/1   # 概览里核对描述列

思科 IOS

思科 IOS
SW-CORE-01(config-if)# description To-Core-SW1 Gi1/0/24 - Trunk
SW-CORE-01(config-if)# end
SW-CORE-01# show interfaces description          # 带状态列的总览表
SW-CORE-01# show interfaces Gi1/0/24 | include Description
! 删除:no description

H3C Comware

H3C Comware
[H3C-GigabitEthernet1/0/1] description To-SW-CORE-01 GE1/0/24
[H3C-GigabitEthernet1/0/1] display this
! 删除:undo description
<H3C> display interface brief                    # 核对描述列内容

描述要素与建议写法

要素作用建议写法
对端设备定位链路另一端是谁设备名放最前,如 To-SW-CORE-01
对端端口插拔/割接时核对准确位置对端端口号,如 Gi1/0/24
用途/类型判断业务影响面如 Trunk、上联、专线、堆叠线
编号/备注多条同类链路区分如 主/备、工单号(放最后,便于替换)
统一格式的价值在批量检索:用「To-对端设备-对端端口-用途」这种固定结构,才能靠过滤命令一次列出某台对端设备的所有相连端口,格式随个人习惯写就失去这个能力。
描述会随配置一起备份导出,也可能被网管平台采集:不要写口令、账号、人员姓名这类敏感信息,用位置或角色描述即可。
部分平台与老网管系统对中文描述显示不佳(乱码或字段截断),跨厂商环境建议统一用英文与半角符号;中文只在纯自管、确定支持的环境使用。

易错点

  • 描述长度超限被截断:对端设备名写在后面就丢了,关键信息必须放最前
  • 描述里写责任人姓名、工单号这类易变信息:人员或流程一变,描述就从帮助变成误导
  • 把描述当唯一台账:设备清空重建或更换硬件后描述全丢,链路台账要在文档系统另存一份
  • 跨平台写中文描述:老设备与网管系统显示乱码,割接时反而增加不确定性
  • 只写一边:一端写清对端、另一端描述写着旧设备名,两边不一致时先核对哪边最近改过

数据来源与参考

  • 华为产品文档:接口描述配置
  • Cisco IOS description 命令
  • H3C Comware 7 接口 description

相关工具

​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌