09-GIR命令
本章节下载: 09-GIR命令 (260.78 KB)
目 录
1.1.2 display gir custom-profile
1.1.4 display gir snapshot compare
1.1.10 gir system-mode maintenance
1.1.11 gir system-mode maintenance maintenance-delay
1.1.12 gir system-mode maintenance revert-delay
1.1.13 gir system-mode maintenance snapshot-delay
config-end命令用来退出自定义custom-profile。
【命令】
config-end
【视图】
custom-profile视图
【缺省用户角色】
network-admin
mdc-admin
【使用指导】
用户能通过该命令结束配置并退出custom-profile视图,也可以通过quit命令退回上一层视图,但是在配置文件里会自动转换成config-end,表示配置文件的配置内容到此结束。
【举例】
# 退出自定义custom-profile。
<Sysname> system-view
[Sysname] gir custom-profile maintenance-mode
Enter commands, one command per line. To end the configuration and quit GIR profile view, execute the 'config-end' or 'quit' command.
[Sysname-gir-mm-profile] config-end
【相关命令】
· sleep instance
· gir custom-profile
· display gir custom-profile
display gir custom-profile命令用来显示自定义custom-profile中的配置信息。
【命令】
display gir custom-profile [ maintenance-mode | normal-mode ]
【缺省情况】
显示维护模式和普通模式下用户自定义配置信息。
【视图】
任意视图
【缺省用户角色】
network-admin
network-operator
mdc-admin
mdc-operator
【参数】
maintenance-mode:显示进入维护模式时自定义custom-profile的配置信息。
normal-mode:显示回切普通模式时自定义custom-profile的配置信息。
【使用指导】
执行本命令,可以显示已配置的自定义custom-profile中的配置信息。如果指定maintenance-mode或normal-mode参数,则显示进入维护模式时自定义custom-profile的配置信息或回切普通模式时自定义custom-profile的配置信息。
【举例】
# 显示自定义配置信息。
<Sysname> display gir custom-profile
[Normal Mode]
undo link-aggregation lacp isolate
sleep instance 1 interval 30
bgp 100
undo isolate enable
[Maintenance Mode]
bgp 100
isolate enable
sleep instance 1 interval 30
link-aggregation lacp isolate
【相关命令】
· gir custom-profile
display gir snapshot命令用来显示GIR快照信息。
【命令】
display gir snapshot
【视图】
任意视图
【缺省用户角色】
network-admin
network-operator
mdc-admin
mdc-operator
【举例】
# 显示GIR快照信息。
<Sysname> display gir snapshot
Name Time Description
before_maintenance Mon Aug 24 10:10:10 2020 Snapshot taken before maintenance
after_maintenance Mon Aug 24 11:10:10 2020 Snapshot taken after maintenance
表1-1 display gir snapshot命令显示信息描述表
字段 |
描述 |
Name |
GIR快照名 |
Time |
GIR快照生成的时间 |
Description |
GIR快照的描述信息 |
【相关命令】
· gir system-mode maintenance
· gir snapshot create
· gir snapshot delete
· display gir snapshot compare
display gir snapshot compare命令用来显示GIR快照比较信息。
【命令】
display gir snapshot compare snapshot1-name snapshot2-name [ verbose ]
【视图】
任意视图
【缺省用户角色】
network-admin
network-operator
mdc-admin
mdc-operator
【参数】
snapshot1-name:表示参与比较的第一个GIR快照的名称。
snapshot2-name:表示参与比较的第二个GIR快照的名称。
verbose:显示GIR快照的详细比较信息,且只显示有差异的信息。如果未指定本参数,则显示GIR快照的概要比较信息。
【使用指导】
当参与比较的快照较大时,会耗时较长。
快照存放的为当前配置对应的NETCONF文件,如果想要了解显示信息中Feature和Tag字段的详细含义,请参见《NETCONF XML API手册》。
【举例】
# 显示GIR快照的详细比较信息。
<Sysname> display gir snapshot compare before_maintenance after_maintenance verbose
Feature Tag before_maintenance after_maintenance
[ifmgr/Interfaces]
[IfIndex:258]
AdminStatus 1 2
OperStatus 1 3
[Route/Ipv4Routes]
[VRF:N/A Topology:N/A ProtocolID: 1]
TotalRoutes 3 4
以上信息表示设备切换到切换到维护模式后:
· 接口258的管理状态从1变成了2,操作状态从1变成了3。
· IPv4路由表的数目从3条变成了4条。
表1-2 display gir snapshot compare命令显示信息描述表
字段 |
描述 |
Feature |
特性名称 |
Tag |
参与比较的Tag |
before_maintenance |
对应字段在before_maintenance中的取值 |
after_maintenance |
对应字段在after_maintenance中的取值 |
# 显示GIR快照的简要比较信息。
<Sysname> display gir snapshot compare before_maintenance after_maintenance
Feature before_maintenance after_maintenance changed
basic
# Interfaces 39 39 N
# ipv4 routes 7 7 N
# ipv6 routes N/A 7 N/A
ifmgr
# interfaces up 1 0 Y
# interfaces down 38 39 Y
# vlan interfaces 2 2 N
# vlan interfaces up 0 0 N
# vlan interfaces down 2 2 N
表1-3 display gir snapshot compare命令显示信息描述表
字段 |
描述 |
Feature |
特性名称 |
before_maintenance |
对应特性在before_maintenance中的配置信息条数 |
after_maintenance |
对应特性在after_maintenance中的配置信息条数 |
Changed |
对应特性的配置信息差异标记,取值包括: · Y:表示配置信息有差异 · N:表示配置信息没有差异 · N/A:表示快照数据过大,无法计算和比较 |
【相关命令】
· display gir snapshot
display gir system-mode命令用来显示当前GIR模式。
【命令】
display gir system-mode
【视图】
任意视图
【缺省用户角色】
network-admin
network-operator
mdc-admin
mdc-operator
【举例】
# 显示当前GIR模式(以isolate方式进入的维护模式)。
<Sysname> display gir system-mode
System mode:Maintenance
Revert-delay time: 5min
Maintenance-delay time: 120s
Snapshot-delay time: 120s
# 显示当前GIR模式(使用shutdown切换为维护模式)。
<Sysname> display gir system-mode
System mode:Maintenance(Shutdown)
Revert-delay time: 5min
Maintenance-delay time: 120s
Snapshot–delay time: 120s
# 显示当前GIR模式(使用custom-profile切换为维护模式)。
<Sysname> display gir system-mode
System mode:Maintenance(custom-profile)
Revert-delay time: 5min
Maintenance-delay time: 120s
Snapshot-delaytime: 120s
# 显示当前GIR模式(普通模式下)。
<Sysname> display gir system-mode
System mode:Normal
Revert–delay time: 5min
Maintenance–delay time: 120s
Snapshot-delay time: 120s
# 显示当前GIR模式(使用custom-profile切回普通模式)。
<Sysname> display gir system-mode
System mode:Normal(custom-profile)
Revert-delay time: 5min
Maintenance–delay time: 120s
Snapshot–delay time: 120s
表1-4 display gir system-mode命令显示信息描述表
字段 |
描述 |
System mode |
GIR系统模式,取值为: · maintenance:表示使用isolate方式进入的维护模式 · maintenance(shutdown):表示使用shutdown方式进入的维护模式 · maintenance(custom-profile):表示使用自定义profile方式进入的维护模式 · normal:表示用对应的方式回切的普通模式 · normal(custom-profile):表示使用自定义profile方式回切的普通模式 |
Revert-delay time |
表示切换到维护模式后延时自动回切的延时时长,单位为min |
Maintenance-delay time |
表示延时放开命令行的延时时长,单位为s |
Snapshot-delay time |
表示切回普通模式后延时生成快照的延时时长,单位为s |
【相关命令】
· gir system-mode maintenance
gir custom-profile命令用来进入自定义custom-profile。
undo gir custom-profile命令用来删除自定义配置文件。
【命令】
gir custom-profile { maintenance-mode | normal-mode }
undo gir custom-profile { maintenance-mode | normal-mode }
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
maintenance-mode:表示自定义custom-profile的命令是进入维护模式时执行的。
normal-mode:表示自定义custom-profile的命令是回切普通模式时执行的。
【使用指导】
custom-profile指的是按照用户配置顺序的配置文件,包含maintenance-mode profile和normal-mode profile。模式切换时会根据切换的模式类型使用对应的自定义custom-profile配置的命令,且使用对应的custom-profile下的用户配置的命令顺序来执行。在进入维护模式时如果指定maintenance-mode profile,则使用该配置进行模式切换;在回切普通模式时使用normal-mode profile取消维护模式,回到普通模式。
可以通过执行本命令进入custom-profile视图,自定义相关命令,实现设备的流量隔离或恢复。
通过自定义custom-profile方式进行模式切换,正切和回切均只能配置一份配置信息。
custom-profile允许为空,反复进入自定义custom-profile配置命令行,只能通过undo gir custom-profile命令删除相应的配置信息。
进入自定义custom-profile配置命令行时,用户应明确配置的命令会对设备产生什么影响,避免错误配置导致流量不能被正确隔离。
配置的命令一般会添加到custom-profile的末尾,并按顺序下发。相同视图的命令会合并到相应的视图下。
设备缺省在系统视图下执行custom-profile中的命令行,如果某条命令需要在系统视图的子视图下执行,则要求先输入进子视图的命令,再输入该命令。
不支持对已配置的命令进行插入、修改或删除操作。进入自定义custom-profile配置命令行后,可通过display gir custom-profile命令查看配置效果,如果发现配置错误,请通过undo gir custom-profile命令删除custom-profile后,重新创建custom-profile。
custom-profile中的命令行有严格的执行顺序,如果custom-profile中要下发的命令之间存在依赖关系,请先输入前提命令。
当用户认为配置的命令可能需要等待一段时间才能生效,可以通过配置并执行完sleep instance命令后等待配置的时间再继续执行下一条命令。如果用户不能明确配置的命令是否需要延时,可以预先设置命令行延时执行并将值设置为0,后续根据需求进行修改。
【举例】
# 配置maintenance-mode profile,设备使用该custom-profile进入维护模式时,需要执行的命令行。
<Sysname> system-view
[Sysname] gir custom-profile maintenance-mode
Enter commands, one command per line. To end the configuration and quit GIR profile view, execute the 'config-end' or 'quit' command.
[Sysname-gir-mm-profile] lacp system-mac 1-1-1
[Sysname-gir-mm-profile] config-end
# 配置normal-mode profile,设备使用该custom-profile切回到普通模式时,需要执行的命令行。
<Sysname> system-view
[Sysname] gir custom-profile normal-mode
Enter commands, one command per line. To end the configuration and quit GIR profile view, execute the 'config-end' or 'quit' command.
[Sysname-gir-nm-profile] lacp system-mac 1-1-1
[Sysname-gir-nm-profile] config-end
【相关命令】
· sleep instance
· config-end
· display gir custom-profile
gir snapshot add命令用来配置创建快照时获取模块数据。
undo gir snapshot add命令用来恢复缺省配置。
【命令】
gir snapshot add { ipv4routes | ipv6routes }*
undo gir snapshot add [ ipv4routes | ipv6routes ]*
【缺省情况】
创建快照时不获取路由信息。
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
ipv4routes:IPv4路由。
ipv6routes:IPv6路由。
【使用指导】
由于路由表的规格比较大,快照创建时默认不获取路由信息。执行本命令可以在创建快照时获取路由信息,便于路由比较信息的显示。
由于部分业务模块数据量较大,可以通过手动添加命令的方式获取包含相关模块数据的快照。
【举例】
# 创建快照时添加IPv4路由信息
<Sysname> system-view
[System] gir snapshot add ipv4routes
# 创建快照时添加IPv6路由信息
<Sysname> system-view
[System] gir snapshot add ipv6routes
【相关命令】
· gir snapshot create
· gir system-mode maintenance
gir snapshot create命令用来创建当前设备状态的系统快照。
【命令】
gir snapshot create snapshot-name description
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
snapshot-name:表示创建的GIR快照名称,名称由数字、英文大小写以及下划线组成。
description:GIR快照的描述信息,为1~255个字符的字符串,区分大小写。
【使用指导】
设备进入维护模式前自动生成快照before_maintenance,退出维护模式后自动生成快照after_maintenance。系统正常运行时用户可以在任何时间手动创建快照,并通过对比两份快照数据,获知系统运行数据的变化。
自定义的快照名称不允许使用before_maintenance、after_maintenance以及all,原因如下:
· 快照名称before_maintenance和after_maintenance被用于模式切换过程中生成的快照。
· 防止在执行gir snapshot delete all命令时仅删除名称为all的快照。
除before_maintenance和after_maintenance外,最多允许创建10个系统快照。
自定义生成快照时,提示正在收集快照信息,请不要进行模式切换、显示快照或删除快照操作。
【举例】
# 创建GIR快照:名字snapA,描述信息:Aaaa。
<Sysname> system-view
[System] gir snapshot create snapA Aaaa
Collecting snapshot data...Please wait.
Generated a snapshot: snapA.
【相关命令】
· display gir snapshot
gir snapshot delete命令用来删除快照。
【命令】
gir snapshot delete { all | snapshot-name }
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
all:表示删除所有快照。
snapshot-name:表示删除指定名的快照。
【举例】
# 删除所有的GIR快照。
<Sysname> system-view
[System] gir snapshot delete all
# 删除名称为snapA的GIR快照。
<Sysname> system-view
[System] gir snapshot delete snapA
【相关命令】
· display gir snapshot
gir system-mode maintenance命令用来将设备从普通模式切换到维护模式。
undo gir system-mode maintenance命令用来将设备从维护模式切回普通模式。
【命令】
gir system-mode maintenance [ shutdown | custom-profile ] [ non-interactive ]
undo gir system-mode maintenance [ custom-profile ] [ non-interactive ]
【缺省情况】
设备处于普通模式,会以isolate方式进入维护模式。
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
shutdown:表示以shutdown方式进入维护模式。
custom-profile:表示以用户自定义的custom-profile来进行模式切换。
non-interactive:表示在后台完成模式切换。模式切换过程中,命令不以交互形式执行,没有提示和确认信息,请谨慎使用。不指定该参数时,以交互形式执行该命令。
【使用指导】
· 执行本命令后,可能会发生流量丢包导致相关业务中断,请谨慎使用。
· 在模式切换过程中,请不要重启设备或进程,设备重启或部分进程重启可能会中止模式切换,而且已下发的业务模块命令无法回滚。
执行本命令前,请注意查看设备是否处于稳定状态,避免命令下发失败。用户可以执行display system stable state命令查看设备状态,有关display system stable state命令的详细介绍,请参见“基础配置命令参考”中的“设备管理”。
当以非用户自定义custom-profile方式进行模式切换,若此时自定义custom-profile内容为空,模式切换后会将本次下发的命令记录为对应的custom-profile。
通过non-interactive方式在后台完成模式切换,不打印中间过程的显示信息,仅提示最后执行结果。
从普通模式切换到维护模式有三种方式:
· 设备缺省以isolate方式进入维护模式,会对协议进行隔离。
· 通过shutdown方式进入维护模式后,会对协议进行隔离,关闭设备上除管理口外的所有接口。
· 通过用户自定义的custom-profile进入维护模式,会按用户配置的命令进行协议隔离。
从维护模式回切到普通模式有两种方式:
· 未指定回切方式时会根据记录的正切的方式,使用与正切对应的方式回切回普通模式。
· 通过用户自定义的custom-profile回切回普通模式,会按用户配置的命令进行协议恢复。
如果在切换到维护模式的过程中,有业务模块命令下发失败,请注意:
· 设备会退出模式切换,回到原有模式,但已下发命令不回滚。
· 设备会提示失败信息,用户可根据业务模块的具体提示信息排查失败原因。
切换到维护模式后,请不要修改各业务模块的配置,否则会导致退出维护模式后,设备配置与原来配置不一致。为了方便用户确认设备进入维护模式前和退出维护模式后是否存在配置差异,可以通过设备提供的GIR快照功能进行查看。
从维护模式切回普通模式后,用户可以执行display gir snapshot compare命令,确认设备进入维护模式前和退出维护模式后是否存在配置差异。如果有配置差异,请用户根据具体的差异信息排查原因。
如果设备正在进行快照显示与比较,请等待快照显示与比较命令结束后再执行模式切换命令。
在M-LAG应用场景下,如果要将设备从维护模式切回到普通模式,请先执行display m-lag mad verbose命令确认设备接口状态未处于“M-LAG MAD DOWN”状态,再执行undo gir system-mode maintenance命令。有关M-LAG的详细介绍,请参见“二层技术-以太网交换配置指导”中的“M-LAG”。
【举例】
# 将设备从普通模式切换到维护模式。
<Sysname> system-view
[Sysname] gir system-mode maintenance
Collecting commands... Please wait.
Configuration to be applied:
bgp 1
isolate enable
isis 2
isolate enable
sleep instance 1 interval 30
link-aggregation lacp isolate
Do you want to continue? [Y/N]: y
Generated a snapshot: before_maintenance.
Applying: bgp 1
Applying: isolate enable
Applying: isis 2
Applying: isolate enable
Applying: sleep instance 1 interval 30
Applying: link-aggregation lacp isolate
Waiting 120 seconds to release the CLI.
Changed to maintenance mode successfully.
# 通过shutdown方式将设备从普通模式切换到维护模式。
<Sysname> system-view
[Sysname] gir system-mode maintenance shutdown
Collecting commands... Please wait.
Configuration to be applied:
isis 2
shutdown process
sleep instance 1 interval 60
shutdown all-physical-interfaces
The operation will shut down all physical interfaces except the management ports.
Do you want to continue? [Y/N]: y
Generated a snapshot: before_maintenance.
Applying: isis 2
Applying: shutdown process
Applying: sleep instance 1 interval 60
Applying: shutdown all-physical-interfaces
Waiting 120 seconds to release the CLI.
Changed to maintenance mode successfully.
# 以custom-profile方式将设备从普通模式切换到维护模式。
<Sysname> system-view
[Sysname] gir system-mode maintenance custom-profile
Collecting commands... Please wait.
Configuration to be applied:
bgp 1
isolate enable
isis 2
isolate enable
sleep instance 1 interval 60
link-aggregation lacp isolate
Do you want to continue? [Y/N]: y
Generated a snapshot: before_maintenance.
Applying: bgp 1
Applying: isolate enable
Applying: isis 2
Applying: isolate enable
Applying: sleep instance 1 interval 60
Applying: link-aggregation lacp isolate
Waiting 120 seconds to release the CLI.
Changed to maintenance mode successfully.
# 将设备从维护模式切回普通模式。
[Sysname] undo gir system-mode maintenance
Collecting commands... Please wait.
Configuration to be applied:
undo link-aggregation lacp isolate
sleep instance 1 interval 30
isis 2
undo isolate enable
bgp 1
undo isolate enable
Do you want to continue? [Y/N]: y
Applying: undo link-aggregation lacp isolate
Applying: sleep instance 1 interval 30
Applying: isis 2
Applying: undo isolate enable
Applying: bgp 1
Applying: undo isolate enable
Waiting 120 seconds to generate a snapshot.
Generated a snapshot: after_maintenance.
Changed to normal mode successfully.
# 通过custom-profile方式将设备从维护模式切回普通模式。
<Sysname> system-view
[Sysname] undo gir system-mode maintenance custom-profile
Collecting commands... Please wait.
Configuration to be applied:
undo link-aggregation lacp isolate
sleep instance 1 interval 60
bgp 1
undo isolate enable
Do you want to continue? [Y/N]: y
Applying: undo link-aggregation lacp isolate
Applying: sleep instance 1 interval 60
Applying: bgp 1
Applying: undo isolate enable
Waiting 120 seconds to generate a snapshot.
Generated a snapshot: after_maintenance.
Changed to normal mode successfully.
# 通过non-interactive方式将设备从普通模式切回维护模式。
<Sysname> system-view
[Sysname] gir system-mode maintenance non-interactive
Mode switching will be performed in the background.
【相关命令】
· display gir custom-profile
· display gir snapshot
· display gir snapshot compare
gir system-mode maintenance maintenance-delay命令用来设置延时放开命令行的延时时长。
undo gir system-mode maintenance maintenance-delay命令用来恢复缺省配置。
【命令】
gir system-mode maintenance maintenance-delay value
undo gir system-mode maintenance maintenance-delay
【缺省情况】
设置延时放开命令行的延时时长为120s。
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
value:取值范围为0~65535,单位为秒。
【使用指导】
当切换到维护模式后,等待指定的时间,才运行配置的命令行。如果在切换到维护模式过程中存在生效较慢的命令,会按照本命令配置的时长延时后再放开所有命令行,等待对应业务模块完成流量切换,可以避免误操作。
【举例】
# 配置延时放开命令行的延时时长为10s。
<Sysname> system-view
[System] gir system-mode maintenance maintenance-delay 10
【相关命令】
· gir system-mode maintenance
gir system-mode maintenance revert-delay命令用来设置切换到维护模式后延时自动回切的延时时长。
undo gir system-mode maintenance revert-delay命令用来恢复缺省配置。
【命令】
gir system-mode maintenance revert-delay value
undo gir system-mode maintenance revert-delay
【缺省情况】
不自动回切。
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
value:延时时长,取值范围为5~65535,单位为分钟。
【使用指导】
当用户维护模式期间需要执行的任务时长较为确定,可以通过该命令配置指定时间后自动切回普通模式。
当回切延时时间为0时,不进行回切。
【举例】
# 设定自动回切的延时时长为10min。
<Sysname> system-view
[System] gir system-mode maintenance revert-delay 10
【相关命令】
· gir system-mode maintenance
gir system-mode maintenance snapshot-delay命令用来设置切回普通模式后延时生成快照的延时时长。
undo gir system-mode maintenance snapshot-delay命令用来恢复缺省配置。
【命令】
gir system-mode maintenance snapshot-delay value
undo gir system-mode maintenance snapshot-delay
【缺省情况】
延时生成快照的延时时长为120s。
【视图】
系统视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
value:延时时长,取值范围为0~65535,单位为秒。
【使用指导】
对于协议恢复较慢的业务模块,可以通过执行本命令配置延时生成after_maintenance的快照,获取更准确和完整的数据。
【举例】
# 设定延时生成after_maintenance的延时时长为10s。
<Sysname> system-view
[System] gir system-mode maintenance snapshot-delay 10
【相关命令】
· gir system-mode maintenance
sleep instance命令用来设置命令行延时执行。
【命令】
sleep instance instance-number interval seconds
【视图】
profile视图
【缺省用户角色】
network-admin
mdc-admin
【参数】
instance-number:表示实例编号,取值范围为0~2177483647。
seconds:表示期望命令行延时的时间,取值范围为0~2177483647,单位为s。
【使用指导】
在对应的custom-profile中配置完业务模块的命令后,如果有命令存在延迟生效的情况,用户需先配置sleep instance命令,具体延时时间可以在配置该命令后进行修改。当业务模块命令下发成功后会等待指定的时间让业务模块命令生效,然后再执行后续命令。
【举例】
# 配置实例1延时10s后再执行
<Sysname> system-view
[Sysname] gir custom-profile maintenance-mode
Enter commands, one command per line. To end the configuration and quit GIR profile view, execute the 'config-end' or 'quit' command.
[Sysname-gir-mm-profile] sleep instance 1 interval 10
【相关命令】
不同款型规格的资料略有差异, 详细信息请向具体销售和400咨询。H3C保留在没有任何通知或提示的情况下对资料内容进行修改的权利!