所选语种没有对应资源,请选择:

本站点使用Cookies,继续浏览表示您同意我们使用Cookies。Cookies和隐私政策>

提示

尊敬的用户,您的IE浏览器版本过低,为获取更好的浏览体验,请升级您的IE浏览器。

升级

S12700 V200R013C00 命令参考

本文档介绍了设备中各特性的配置命令,包括每条命令的功能、格式、参数、视图、缺省级别、使用指南、举例和相关命令。
评分并提供意见反馈 :
华为采用机器翻译与人工审校相结合的方式将此文档翻译成不同语言,希望能帮助您更容易理解此文档的内容。 请注意:即使是最好的机器翻译,其准确度也不及专业翻译人员的水平。 华为对于翻译的准确性不承担任何责任,并建议您参考英文文档(已提供链接)。
OPS配置命令

OPS配置命令

命令支持情况

命令支持情况请见各命令行中的说明,如无相关描述,默认所有款型支持该命令。

assistant scheduler suspend

命令功能

assistant scheduler suspend命令用来关闭OPS维护助手功能。

undo assistant scheduler suspend命令用来打开OPS维护助手功能。

缺省情况下,OPS维护助手功能处于打开状态。

命令格式

assistant scheduler suspend

undo assistant scheduler suspend

参数说明

视图

OPS视图

缺省级别

3:管理级

使用指南

当用户不再需要设备提供的OPS维护助手功能时,例如:

  • 当用户需要逐条清除已配置的Python脚本助手,可以先执行assistant scheduler suspend命令关闭OPS维护助手功能,避免脚本助手在清除过程中运行。

  • 在系统维护时,通过assistant scheduler suspend命令可以暂时屏蔽OPS维护助手的功能。

assistant scheduler suspend命令关闭OPS维护助手功能后,所有的Python脚本助手都不再运行。

使用实例

# 关闭OPS维护助手功能。

<HUAWEI> system-view
[HUAWEI] ops
[HUAWEI-ops] assistant scheduler suspend

display ops assistant

命令功能

display ops assistant命令用来查看Python脚本助手信息。

命令格式

display ops assistant { current [ verbose ] | history } [ name assistant-name ]

参数说明

参数

参数说明

取值

current

指定显示Python脚本助手当前状态的简要信息。

-

verbose

指定显示Python脚本助手当前状态的详细信息。

-

history

指定显示Python脚本助手历史运行信息。

-

name assistant-name

指定Python脚本助手名称,即配置脚本助手的Python脚本名称。

必须是设备上已经配置的脚本助手的Python脚本名称。

视图

所有视图

缺省级别

3:管理级

使用指南

用户可以通过本命令查看系统中Python脚本助手的当前状态或历史运行信息,包括Python脚本助手名称、运行状态、运行结果等。最多能查看最近100次的历史Python脚本助手信息。

使用实例

# 查看Python脚本助手当前状态的简要信息。

<HUAWEI> display ops assistant current
------------------------------------------------------                          
Assistant                     State          Condition                          
------------------------------------------------------                          
subscribe_cli_sync_1.py       ready          cli                                
user-correlat-10.py           ready          multi                              
------------------------------------------------------ 
表3-101  display ops assistant current命令输出信息描述

项目

描述

Assistant

Python脚本助手名称。

State

Python脚本助手当前状态。
  • ready:等待触发
  • pending:等待运行状态
  • waiting:常驻脚本等待第二次触发
  • running:正在执行
  • shutdown:Python脚本助手停止
  • suspend:OPS维护助手功能关闭

Condition

Python脚本助手的触发条件。
  • cli:命令行事件
  • device:单板状态变化事件
  • iclog:日志事件
  • ifm:端口统计事件
  • lldp:LLDP邻居变化事件
  • multi:复杂事件
  • timer:定时器事件
  • trap:告警事件
  • URM:路由事件

# 查看Python脚本助手当前状态的详细信息。

<HUAWEI> display ops assistant current verbose
Assistant information                                                           
  Name                          :user-correlat-10.py                            
  State                         :ready                                          
Running statistics                                                              
  Running times                 :0                                              
  Queue size/(free)             :5/(5)                                          
  Skip for queue full           :0                                              
  Skip for delay                :0                                              
  Skip for suppression          :0                                              
Condition information                                                           
  Condition tag                 :cli1                                           
    Condition type              :multi                                          
    Threshold                   :1                                              
    Period (s)                  :0                                              
    Hits in period              :0                                              
  Condition tag                 :cli2                                           
    Condition type              :multi                                          
    Threshold                   :1                                              
    Period (s)                  :0                                              
    Hits in period              :0                                              
  Condition tag                 :cli3                                           
    Condition type              :multi                                          
    Threshold                   :1                                              
    Period (s)                  :0                                              
    Hits in period              :0                                              
  Condition tag                 :cli4                                           
    Condition type              :multi                                          
    Threshold                   :1                                              
    Period (s)                  :0                                              
    Hits in period              :0                                              
  Correlate expression          :((cli1 andnot cli2) and (cli3 andnot cli4))    
  Trigger control                                                               
    Threshold                   :1                                              
    Period (s)                  :30                                             
    Delay (s)                   :0                                              
    Suppress max                :0                                              
    Hits in period              :0   
表3-102  display ops assistant current verbose命令输出信息描述

项目

描述

Assistant information

Python脚本助手的信息。

Name

Python脚本助手的名称。

State

Python脚本助手当前状态。
  • ready:等待触发
  • pending:等待运行状态
  • waiting:常驻脚本等待第二次触发
  • running:正在执行
  • shutdown:Python脚本助手停止
  • suspend:OPS维护助手功能关闭

Running statistics

Python脚本助手运行的详细信息。

Running times

运行次数。

Queue size/(free)

缓存Python脚本助手的数目,超过数目的Python脚本助手被丢弃。

Skip for queue full

因满队列而丢弃的任务数。

Skip for delay

延迟期间丢弃的任务数。

Skip for suppression

被抑制的触发总次数。

Condition information

Python脚本助手中的条件信息,即订阅的事件。仅包含复杂事件脚本显示Condition information字段。

Condition tag

条件名称。

Condition type

触发条件类型,取值为multi。

Threshold

周期内发生次数的阈值。缺省值为1。

Period (s)

检查周期。缺省值为30,单位为秒。

Hits in period

周期内已命中次数。

Correlate expression

条件组合方式。

Trigger control

触发控制。

Delay (s)

触发工作任务的延迟时间。缺省值为0,单位为秒。

Suppress max

周期内最大触发次数。缺省值为0,不抑制。

# 查看Python脚本助手历史运行信息。

<HUAWEI> display ops assistant history
Assistant history information                                                   
  Name                          :subscribe_cli_sync_1.py                        
  Running information                                                           
    Trigger condition           :cli                                            
    Trigger event name          :cli1                                           
    Trigger time                :2017-03-25 19:48:51                            
    Execute start time          :2017-03-25 19:48:51                            
    Execute end time            :2017-03-25 19:48:53                            
    Execute result              :normal 
表3-103  display ops assistant history命令输出信息描述

项目

描述

Assistant history information

Python脚本助手的历史信息。

Name

Python脚本助手的名称。

Running information

Python脚本助手的运行信息。

Trigger condition

Python脚本助手的触发条件。
  • cli:命令行事件
  • device:单板状态变化事件
  • iclog:日志事件
  • ifm:端口统计事件
  • lldp:LLDP邻居变化事件
  • multi:复杂事件
  • timer:定时器事件
  • trap:告警事件
  • URM:路由事件

Trigger event name

Python脚本助手的触发事件名称。

Trigger time

Python脚本助手的触发时间。

Execute start time

Python脚本助手的执行时间。

Execute end time

Python脚本助手的结束时间。

Execute result

Python脚本助手的执行结果。
  • normal:脚本助手正常结束。
  • abnormal:脚本发生异常。
  • userCancel:用户主动结束脚本运行。
  • duplicate:脚本文件名和库文件名冲突。
  • os:脚本异常系统主动杀死脚本进程。

display ops environment

命令功能

display ops environment命令用来查看用户自定义环境变量的信息。

命令格式

display ops environment

参数说明

视图

所有视图

缺省级别

3:管理级

使用指南

执行environment命令配置用户自定义环境变量后,可以通过本命令查看用户自定义环境变量的信息。

使用实例

# 查看用户自定义环境变量。

<HUAWEI> display ops environment
No.  Name                          Value                                        
1    user                          admin                                        
表3-104  display ops environment命令输出信息描述

项目

描述

No.

用户自定义环境变量的编号,取值范围为1~100。

Name

用户自定义环境变量的名称。

该参数可以通过命令environment配置。

Value

用户自定义环境变量的值。

该参数可以通过命令environment配置。

相关主题

display ops error

命令功能

display ops error命令用来查看脚本的异常信息。

命令格式

display ops error [ name assistant-name ]

参数说明

参数

参数说明

取值

name assistant-name

指定Python脚本助手名称,即配置脚本助手的Python脚本名称。

必须是设备上已经配置的脚本助手的Python脚本名称。

视图

所有视图

缺省级别

3:管理级

使用指南

用户可以通过本命令查看所有脚本或者指定某个脚本的异常信息。根据查看到的异常信息,可以修改对应脚本。

使用实例

# 查看所有脚本的异常信息。

<HUAWEI> display ops error
--------------------------------------------------------------------------------
test12.py:                                                                      
Traceback (most recent call last):                                              
  File ".lib/frame.py", line 114, in <module>                                   
    ret = m.ops_execute(ops)                                                    
  File "flash:$_user/test12.py", line 7, in ops_execute                         
    status, err_context = ops.context.save(varName, value)                      
NameError: global name 'varName' is not defined                                 
                                                                                
--------------------------------------------------------------------------------
test13.py:                                                                      
Traceback (most recent call last):                                              
  File ".lib/frame.py", line 114, in <module>                                   
    ret = m.ops_execute(ops)                                                    
  File "flash:$_user/test13.py", line 6, in ops_execute                         
    status, err_log = ops.syslog("Syslog: Hello, World..", ops.CRITICAL, "syslog
")                                                                              
AttributeError: 'module' object has no attribute 'syslog'                       
                                                                                
--------------------------------------------------------------------------------
表3-105  display ops error命令输出信息描述

项目

描述

test12.py

Python脚本文件名称。

Traceback (most recent call last)

追踪到最后调用的异常。

File ".lib/frame.py", line 114, in <module>

发生异常的栈。

File "flash:$_user/test12.py", line 7, in ops_execute

发生异常的位置信息,包括Python脚本名称、行数和出错阶段。

status, err_context = ops.context.save(varName, value)

存在异常的内容。

NameError

变量错误。尝试访问一个没有申明的变量。

AttributeError

属性错误。尝试访问未知的对象属性。

display ops system-script

命令功能

display ops system-script命令用来查看系统自带的OPS脚本。

命令格式

display ops system-script

参数说明

视图

所有视图

缺省级别

1:监控级

使用指南

应用场景

当使用OIDS与OPS联动功能时,需要使用OPS脚本订阅OIDS事件。为了减少用户制作脚本或者从网站下载脚本,以及导入设备的麻烦,设备会携带OPS脚本。可以通过display ops system-script命令查看系统自带的脚本。

注意事项

系统自带的脚本缺省未安装。

使用实例

# 查看系统自带的OPS脚本。

<HUAWEI> display ops system-script
ScriptName                      Description                                                                                         
--------------------------------------------------------------------------------                                                    
huawei_oids.py                  The OIDS sample script describes the subscriptio                                                    
                                n process. The execution result of the script ha                                                    
                                s been recorded to OIDS. You can refer to this s                                                    
                                cript to implement the OIDS script process. 
表3-106  display ops system-script命令输出信息描述

项目

描述

ScriptName

脚本名称

Description

描述

environment

命令功能

environment命令用来配置用户自定义环境变量。

undo environment命令用来删除用户自定义环境变量。

缺省情况下,没有配置用户自定义环境变量。

命令格式

environment variable-name variable-value

undo environment variable-name

参数说明

参数

参数说明

取值

variable-name

指定用户自定义环境变量的名称。

字符串形式,区分大小写,不支持空格,长度取值范围为1~31。以字母开头,只能包括字母、数字和下划线。

variable-value

指定用户自定义环境变量的值。

字符串形式,区分大小写,不支持空格,长度取值范围为1~64。当输入的字符串两端使用引号时,可在字符串中输入空格。

视图

OPS视图

缺省级别

3:管理级

使用指南

应用场景

环境变量由环境变量名和环境变量值组成。在Python脚本中,用户可以在应该输入参数的地方输入自定义的环境变量名,表示此处需要引用环境变量值。系统在运行Python脚本时,会自动用环境变量值去替代环境变量名。如果需要修改参数的值,可以直接在设备上修改环境变量值,无需重新修改和安装Python脚本。因此,定义和使用用户自定义环境变量可以简化Python脚本的配置,提高Python脚本的灵活性和易用性。

注意事项

重复指定variable-name参数时,系统会提示该用户自定义环境变量已存在,用户可以选择是否覆盖变量值。覆盖后,需要执行undo script-assistant python命令删除已配置的使用该环境变量的Python脚本助手,再执行script-assistant python命令重新配置该Python脚本助手。

设备最多支持配置100个环境变量。

执行display ops environment命令可以查看已经配置的用户自定义环境变量。

使用实例

# 配置用户自定义环境变量user的取值为admin

<HUAWEI> system-view
[HUAWEI] ops
[HUAWEI-ops] environment user admin

ops

命令功能

ops命令用来进入OPS视图。

命令格式

ops

参数说明

视图

系统视图

缺省级别

3:管理级

使用指南

进入OPS视图后,可以进行Python脚本助手等相关配置。

使用实例

# 进入OPS视图。

<HUAWEI> system-view
[HUAWEI] ops
[HUAWEI-ops]

ops abort

命令功能

ops abort命令用来停止所有OPS Python脚本的运行。

命令格式

ops abort

参数说明

视图

所有视图

缺省级别

3:管理级

使用指南

应用场景

OPS Python脚本异常导致设备无法正常输入命令时,可以通过执行此命令停止所有OPS Python脚本运行使设备恢复正常。

注意事项

主用主控板执行命令ops abort不会被命令行事件订阅API(ops.cli.subscribe)捕捉,在备用主控板执行命令ops abort会被命令行事件订阅API(ops.cli.subscribe)捕捉。

使用实例

# 停止所有OPS脚本的运行。

<HUAWEI> ops abort

ops install file

命令功能

ops install file命令用来安装Python脚本。

命令格式

ops install file file-name [ destination directory ]

参数说明

参数

参数说明

取值

file-name

指定被安装Python脚本的路径和文件名。

  • 如果Python脚本存放在设备的根目录下时,可以直接指定文件名。

  • 如果Python脚本存放在设备的其他目录下时,file-name需包含路径和文件名。

字符串形式,不区分大小写,不支持空格,长度取值范围为4~64。Python脚本文件后缀名为“.py”。

说明:

file-name参数不能指定为内置的Python脚本文件名,包括:ConfigParser.py、copy_reg.py、locale.py、sre.py、Queue.py、decimal.py、macurl2path.py、sre_compile.py、StringIO.py、dis.py、modulefinder.py、sre_constants.py、UserDict.py、dummy_thread.py、ntpath.py、sre_parse.py、UserList.py、dummy_threading.py、nturl2path.py、stat.py、UserString.py、filecmp.py、numbers.py、string.py、__future__.py、fileinput.py、opcode.py、stringold.py、_abcoll.py、fnmatch.py、os.py、struct.py、_pyio.py、formatter.py、os2emxpath.py、subprocess.py、_strptime.py、fractions.py、pickle.py、sysconfig.py、_threading_local.py、functools.py、pkgutil.py、textwrap.py、_weakrefset.py、genericpath.py、platform.py、threading.py、abc.py、getopt.py、posixpath.py、token.py、argparse.py、getpass.py、pprint.py、tokenize.py、atexit.py、gettext.py、re.py、trace.py、base64.py、glob.py、repr.py、traceback.py、bisect.py、heapq.py、runpy.py、types.py、calendar.py、imputil.py、sched.py、user.py、codecs.py、inspect.py、sets.py、warnings.py、collections.py、io.py、shutil.py、weakref.py、contextlib.py、keyword.py、site.py、xmllib.py、copy.py、linecache.py、socket.py、_cli.py、_device.py、_frame.py、_route.py、_timer.py、_common.py、_environment.py、_iclog.py、_snmp.py、_trap.py、_context.py、_farg.py、_lldp.py、_terminal.py和ops.py

destination directory

指定脚本的安装路径。

字符串形式,不区分大小写,不支持空格,长度取值范围为1~64。

如果不指定该参数,则脚本被安装在$_user目录下;如果指定该参数,则脚本被安装在$_user/directory目录下。如果目录名称不存在,则会创建新目录。

说明:

file-name长度和脚本的安装路径总长度不超过118。总长度是指存储路径+$_user+目录名+文件名。

脚本安装路径不能为huawei_pys。

directory指定的路径,目录深度不能大于3级。

视图

用户视图

缺省级别

3:管理级

使用指南

应用场景

OPS支持用户在设备上执行自己编写的脚本,脚本需要在配置脚本助手后才能被执行。因此,在配置脚本助手前,需要先安装该脚本。

执行命令dir(用户视图)可以查到$_user目录下已经安装的脚本信息。

注意事项

  • 安装脚本前需要上传脚本文件至设备的flash:根目录下。
  • 安装脚本时保证设备有足够的存储空间,否则脚本安装失败。
  • 指定的安装目录如果不存在,会自动创建,最多只能在$_user目录下创建7层子目录。
  • 待安装的脚本的名称不能与设备上已存在的目录名称相同。脚本安装成功后,则不能再创建与已安装的脚本相同名称的目录。
  • 用户只能通过执行ops install file拷贝文件到$_user目录下。安装到此目录下的脚本文件,会自动备份到备板
  • 对于已经安装的脚本,如需修改,必须执行ops uninstall file命令卸载并执行delete(用户视图)命令将脚本文件删除,修改完成之后再重新上传文件并安装。
  • 建议安装到$_user目录下的总文件大小少于100MB,否则会影响主备同步的性能。

使用实例

# flash:根目录下的脚本文件config.py安装到默认flash:/$_user目录。

<HUAWEI> ops install file config.py

# 将flash:根目录下的脚本文件config.py安装到指定flash:/$_user/user目录。

<HUAWEI> ops install file config.py destination user

# 将flash:/admin目录下的脚本文件config.py安装到默认flash:/$_user目录。

<HUAWEI> ops install file admin/config.py
相关主题

ops uninstall file

命令功能

ops uninstall file命令用来卸载Python脚本。

命令格式

ops uninstall file file-name

参数说明

参数

参数说明

取值

file-name

指定被卸载脚本的文件名。

必须是设备上已经安装的脚本的文件名。

如果删除的是指定安装目录下的脚本文件,取值为directory/file-name,其中directory为脚本的安装路径。

说明:

file-name长度和脚本的安装路径总长度不超过118。总长度是指存储路径+$_user+目录名+文件名。

视图

用户视图

缺省级别

3:管理级

使用指南

应用场景

用户可以卸载某些不再需要执行的脚本,以节约设备的存储空间。如果用户需要更新已经安装过的脚本,也需要先卸载该文件,修改完成后再重新安装。

注意事项

已经配置脚本助手的脚本不能被此命令卸载。必须在删除脚本助手之后,才能被卸载。

已经配置脚本助手的脚本,若调用了其他脚本,其他脚本不受防卸载保护。因此建议相关功能在一个脚本中实现。

使用实例

# 卸载默认flash:/$_user目录下的脚本文件config.py。

<HUAWEI> ops uninstall file config.py

# 卸载指定flash:/$_user/user目录下的脚本文件config.py。

<HUAWEI> ops uninstall file user/config.py
相关主题

script-assistant python

命令功能

script-assistant python命令用来配置Python脚本助手。

undo script-assistant python命令用来删除Python脚本助手。

缺省情况下,没有配置Python脚本助手。

命令格式

script-assistant python script-name

undo script-assistant python script-name

参数说明

参数

参数说明

取值

script-name

指定脚本助手名称,即配置脚本助手的Python脚本名称。

必须是设备上已经安装的Python脚本文件的名称。

说明:

script-name参数不能指定为内置的Python脚本文件名。包括:ConfigParser.py、copy_reg.py、locale.py、sre.py、Queue.py、decimal.py、macurl2path.py、sre_compile.py、StringIO.py、dis.py、modulefinder.py、sre_constants.py、UserDict.py、dummy_thread.py、ntpath.py、sre_parse.py、UserList.py、dummy_threading.py、nturl2path.py、stat.py、UserString.py、filecmp.py、numbers.py、string.py、__future__.py、fileinput.py、opcode.py、stringold.py、_abcoll.py、fnmatch.py、os.py、struct.py、_pyio.py、formatter.py、os2emxpath.py、subprocess.py、_strptime.py、fractions.py、pickle.py、sysconfig.py、_threading_local.py、functools.py、pkgutil.py、textwrap.py、_weakrefset.py、genericpath.py、platform.py、threading.py、abc.py、getopt.py、posixpath.py、token.py、argparse.py、getpass.py、pprint.py、tokenize.py、atexit.py、gettext.py、re.py、trace.py、base64.py、glob.py、repr.py、traceback.py、bisect.py、heapq.py、runpy.py、types.py、calendar.py、imputil.py、sched.py、user.py、codecs.py、inspect.py、sets.py、warnings.py、collections.py、io.py、shutil.py、weakref.py、contextlib.py、keyword.py、site.py、xmllib.py、copy.py、linecache.py、socket.py、_cli.py、_device.py、_frame.py、_route.py、_timer.py、_common.py、_environment.py、_iclog.py、_snmp.py、_trap.py、_context.py、_farg.py、_lldp.py、_terminal.py和ops.py

视图

OPS视图

缺省级别

3:管理级

使用指南

应用场景

随着网络的迅猛发展和不断普及,现有的网络设备只能提供有限的功能和已知的服务,差异化的需求很难得到满足。用户可以通过在OPS中执行脚本,实现用户自定义功能。

设备支持内嵌Python脚本解释器,执行script-assistant python命令启动脚本运行,同时注册脚本中定义的事件。

前置条件

脚本已上传至设备,并在用户视图下执行ops install file命令安装Python脚本。

注意事项

一个Python脚本只能配置一个脚本助手。设备上最多支持配置100个Python脚本助手。

系统不检查脚本内容的正确性。

执行undo script-assistant python命令卸载脚本助手会导致对应的Python脚本执行终止。

使用实例

# 配置脚本config.py的脚本助手。

<HUAWEI> ops install file config.py
<HUAWEI> system-view
[HUAWEI] ops
[HUAWEI-ops] script-assistant python config.py

shutdown script-assistant

命令功能

shutdown script-assistant命令用来停止Python脚本助手。

undo shutdown script-assistant命令用来打开Python脚本助手。

缺省情况下,Python脚本助手处于打开状态。

命令格式

shutdown script-assistant script-name

undo shutdown script-assistant script-name

参数说明

参数

参数说明

取值

script-name

指定Python脚本助手名称,即配置脚本助手的Python脚本名称。

必须是设备上已经配置的脚本助手的Python脚本名称。

视图

OPS视图

缺省级别

3:管理级

使用指南

应用场景

用户可以执行shutdown script-assistant命令停止Python脚本助手,使对应脚本助手的脚本不会被触发运行。

注意事项

当Python脚本助手正在运行时,执行此操作将导致运行中断,请谨慎执行该操作。

使用实例

# 停止脚本config.py的脚本助手。

<HUAWEI> system-view
[HUAWEI] ops
[HUAWEI-ops] shutdown script-assistant config.py
Info: Succeeded in stopping script assistant config.py.
翻译
下载文档
更新时间:2019-04-08

文档编号:EDOC1100065708

浏览量:10097

下载量:198

平均得分:
本文档适用于这些产品
相关版本
相关文档
Share
上一页 下一页