HPE Networking Comware 5960 Switch Series Network Programmability Configuration Guide

HPE Networking Comware 5960 Switch Series

Network Programmability Configuration Guide

Software

version: Release 9126P01 and later

Document version: 6W100-20230428

The information contained herein is subject to change without notice. The only warranties for Hewlett Packard

Enterprise products and services are set forth in the express warranty statements accompanying such

products and services. Nothing herein should be construed as constituting an additional warranty. Hewlett

Packard Enterprise shall not be liable for technical or editorial errors or omissions contained herein.

Confidential computer software. Valid license from Hewlett Packard Enterprise required for possession, use, or

copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software

Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor’s

standard commercial license.

Links to third-party websites take you outside the Hewlett Packard Enterprise website. Hewlett Packard

Enterprise has no control over and is not responsible for information outside the Hewlett Packard Enterprise

website.

Acknowledgments

Intel®, Itanium®, Pentium®, Intel Inside®, and the Intel Inside logo are trademarks of Intel Corporation in the

United States and other countries.

Microsoft® and Windows® are either registered trademarks or trademarks of Microsoft Corporation in the

United States and/or other countries.

Adobe® and Acrobat® are trademarks of Adobe Systems Incorporated.

Java and Oracle are registered trademarks of Oracle and/or its affiliates.

UNIX® is a registered trademark of The Open Group.

Contents

Configuring RESTful ······················································································ 4

About RESTful ··················································································································································· 4

Configuring RESTful over HTTP ························································································································ 4

Configuring RESTful over HTTPS······················································································································ 4

Using Tcl ······································································································· 6

About Tcl ···························································································································································· 6

Restrictions and guidelines: Tcl ························································································································· 6

Using Tcl commands to configure the device ···································································································· 6

Restrictions and guidelines ························································································································ 6

Procedure ··················································································································································· 6

Executing Comware commands in Tcl configuration view ················································································· 7

About executing Comware commands in Tcl configuration view ······························································· 7

Restrictions and guidelines ························································································································ 7

Comware 9 extended Tcl API ········································································ 9

create-cli····························································································································································· 9

destroy-cli ··························································································································································· 9

write-cli ······························································································································································· 9

execute-shell-cmd ············································································································································ 10

getmaxslotnumber············································································································································ 10

getminslotnumber············································································································································· 11

transfer ····························································································································································· 11

Using Python ······························································································· 13

About Python···················································································································································· 13

Executing a Python script································································································································· 13

Entering the Python shell ································································································································· 13

Importing and using the extended Python API ································································································· 13

Importing the entire extended API and using the API ·············································································· 13

Importing an extended API function and using the function ····································································· 14

Exiting the Python shell ···································································································································· 14

Python usage examples ··································································································································· 14

Example: Using a Python script for device configuration ········································································· 14

Comware 9 extended Python API ································································ 16

channel····························································································································································· 16

CLI···································································································································································· 17

get_error··························································································································································· 17

get_output ························································································································································ 18

get_slot_range ················································································································································· 18

Transfer ···························································································································································· 18

Configuring NETCONF ················································································ 20

About NETCONF ············································································································································· 20

NETCONF structure ································································································································· 20

Basic NETCONF concepts ······················································································································· 20

NETCONF message format ····················································································································· 22

How to use NETCONF ····························································································································· 24

Protocols and standards ·························································································································· 24

NETCONF tasks at a glance ···························································································································· 24

Establishing a NETCONF session ··················································································································· 25

Restrictions and guidelines for NETCONF session establishment ·························································· 25

Setting NETCONF session attributes······································································································· 25

Establishing NETCONF over SOAP sessions ························································································· 26

Establishing NETCONF over SSH sessions ···························································································· 27

Establishing NETCONF over Telnet or NETCONF over console sessions ············································· 27

Exchanging capabilities ···························································································································· 28

Retrieving operational and configuration data from the device ········································································ 28

Restrictions and guidelines for device configuration retrieval ·································································· 28

Retrieving device configuration and state information ············································································· 29

Retrieving non-default settings················································································································· 31

Retrieving NETCONF information ············································································································ 32

Retrieving YANG file content ··················································································································· 32

Retrieving NETCONF session information ······························································································· 33

Example: Retrieving a data entry for the interface table ·········································································· 33

Example: Retrieving syslog configuration data ························································································ 35

Example: Retrieving non-default configuration data ················································································ 36

Example: Retrieving NETCONF session information··············································································· 37

Filtering data ···················································································································································· 38

About data filtering ··································································································································· 38

Restrictions and guidelines for data filtering ···························································································· 38

Table-based filtering ································································································································· 38

Column-based filtering ····························································································································· 39

Example: Filtering data with regular expression match············································································ 41

Example: Filtering data by conditional match··························································································· 43

Locking or unlocking the running configuration ································································································ 44

About configuration locking and unlocking ······························································································· 44

Restrictions and guidelines for configuration locking and unlocking ························································ 44

Locking the running configuration ············································································································ 44

Unlocking the running configuration ········································································································· 45

Example: Locking the running configuration ···························································································· 45

Modifying the configuration ······························································································································ 46

About the <edit-config> operation ············································································································ 46

Example: Modifying the configuration ······································································································ 47

Saving the running configuration ····················································································································· 48

About the <save> operation ····················································································································· 48

Restrictions and guidelines ······················································································································ 48

Example: Saving the running configuration ······························································································ 49

Loading the configuration ································································································································· 50

About the <load> operation ······················································································································ 50

Restrictions and guidelines ······················································································································ 50

Rolling back the configuration ·························································································································· 51

Restrictions and guidelines ······················································································································ 51

Rolling back the configuration based on a configuration file ···································································· 51

Rolling back the configuration based on a rollback point ········································································· 51

Performing CLI operations through NETCONF································································································ 55

About CLI operations through NETCONF ································································································ 55

Restrictions and guidelines ······················································································································ 55

Example: Performing CLI operations ······································································································· 56

Subscribing to events ······································································································································· 57

About event subscription ·························································································································· 57

Restrictions and guidelines ······················································································································ 57

Subscribing to syslog events ···················································································································· 57

Subscribing to events monitored by NETCONF······················································································· 58

Subscribing to events reported by modules ····························································································· 60

Canceling an event subscription ·············································································································· 61

Example: Subscribing to all syslog events ······························································································· 61

Example: Subscribing to events reported by modules ············································································· 62

Terminating NETCONF sessions ····················································································································· 64

About NETCONF session termination ····································································································· 64

Example: Terminating another NETCONF session ················································································· 64

Returning to the CLI ········································································································································· 65

iii

Restrictions and guidelines ······················································································································ 65

Example: Returning to the CLI ················································································································· 65

Displaying and clearing NETCONF service statistics ······················································································ 66

Displaying and clearing NETCONF session statistics······················································································ 66

Supported NETCONF operations ································································ 67

action ························································································································································ 67

CLI ···························································································································································· 67

close-session ··········································································································································· 68

edit-config: create ····································································································································· 68

edit-config: delete ····································································································································· 69

edit-config: merge ···································································································································· 69

edit-config: remove ··································································································································· 69

edit-config: replace ··································································································································· 70

edit-config: test-option ······················································································································ 70

edit-config: default-operation···················································································································· 71

edit-config: error-option ···························································································································· 72

edit-config: incremental ···························································································································· 73

get ···························································································································································· 73

get-bulk ···················································································································································· 74

get-bulk-config ·········································································································································· 74

get-config ················································································································································· 75

get-sessions ············································································································································· 75

kill-session ················································································································································ 75

load ·························································································································································· 76

lock ··························································································································································· 76

rollback ····················································································································································· 76

save ·························································································································································· 77

unlock ······················································································································································· 77

Document conventions and icons ································································ 78

Conventions ····················································································································································· 78

Network topology icons ···································································································································· 79

Support and other resources ······································································· 80

Accessing Hewlett Packard Enterprise Support······························································································· 80

Accessing updates ··········································································································································· 80

Websites ·················································································································································· 81

Customer self repair ································································································································· 81

Remote support ········································································································································ 81

Documentation feedback ························································································································· 81

Index ············································································································ 83

Configuring RESTful

About RESTful

The device provides the Representational State Transfer application programming interface

(RESTful API). Based on this API, you can use programming languages such as Python, Ruby, or

Java to write programs to perform the following tasks:

•

Send RESTful requests to the device to pass authentication.

•

Use RESTful API operations to configure and manage the device. RESTful API operations

include Get, Put, Post, and Delete.

The device supports using HTTP or HTTPS to transfer RESTful packets.

Configuring RESTful over HTTP

1. Enter system view.

system-view

2. (Optional.) Specify the service port number for RESTful access over HTTP.

restful http port port-number

By default, the service port number for RESTful access over HTTP is 80.

3. Enable RESTful over HTTP.

restful http enable

By default, RESTful over HTTP is disabled.

4. Create a local user and enter local user view.

local-user user-name [ class manage ]

5. Configure a password for the local user.

password [ { hash | simple } password ]

6. (Optional.) Assign a user role to the local user.

authorization-attribute user-role user-role

The default user role is network-operator for a RESTful user.

7. Specify the HTTP service for the local user.

service-type http

By default, no service type is specified for a local user.

Configuring RESTful over HTTPS

1. Enter system view.

system-view

2. (Optional.) Specify the service port number for RESTful access over HTTPS.

restful https port port-number

By default, the service port number for RESTful access over HTTPS is 443.

3. Enable RESTful over HTTPS.

restful https enable

By default, RESTful over HTTPS is disabled.

4. Create a local user and enter local user view.

local-user user-name [ class manage ]

5. Configure a password for the local user.

password [ { hash | simple } password ]

6. (Optional.) Assign a user role to the local user.

authorization-attribute user-role user-role

The default user role is network-operator for a RESTful user.

7. Specify the HTTPS service for the local user.

service-type https

By default, no service type is specified for a local user.

Using Tcl

About Tcl

Comware 9 provides a built-in tool command language (Tcl) interpreter. From user view, you can use

the tclsh command to enter Tcl configuration view to execute the following commands:

•

Tcl 8.5 commands.

•

Comware commands.

The Tcl configuration view is equivalent to the user view. You can use Comware commands in Tcl

configuration view in the same way they are used in user view.

Restrictions and guidelines: Tcl

To return from a subview under Tcl configuration view to the upper-level view, use the quit

command.

To return from a subview under Tcl configuration view to the Tcl configuration view, press Ctrl+Z.

Using Tcl commands to configure the device

Restrictions and guidelines

When you use Tcl to configure the device, follow these restrictions and guidelines:

•

You can apply Tcl environment variables to Comware commands.

•

No online help information is provided for Tcl commands.

•

You cannot press Tab to complete an abbreviated Tcl command.

•

Make sure the Tcl commands can be executed correctly.

•

As a best practice, log in through Telnet or SSH. You cannot stop Tcl commands by using a

shortcut key or a CLI command. If a problem occurs when the Tcl commands are being

executed, you can terminate the process by closing the connection if you logged in through

Telnet or SSH. If you logged in from the console port, you must perform one of the following

tasks:

 Restart the device.

 Log in to the device by using a different method, and use the free line command to

release the console line. For more information about the command, see Fundamentals

Command Reference.

•

You can press Ctrl+D to abort Tcl command read stdin.

Procedure

1. Enter Tcl configuration view from user view.

tclsh

2. Execute a Tcl command.

Tcl command

3. Return from Tcl configuration view to user view.

 tclquit

 quit

Executing Comware commands in Tcl

configuration view

About executing Comware commands in Tcl configuration

view

To execute a Comware command in Tcl configuration view, use one of the following methods:

•

Enter the Comware command directly. If a Tcl command uses the same command string as the

Comware command, the Tcl command is executed.

•

Prefix the Comware command with the cli keyword. If a Tcl command uses the same

command string as the Comware command, the Comware command is executed.

Restrictions and guidelines

Follow these restrictions and guidelines when you execute Comware commands in Tcl configuration

view:

•

To specify a string enclosed in quotation marks (") or braces ({ and }), you must use the escape

character (\) before the quotation marks or braces. For example, to specify "a" as the

description for an interface, you must enter description \"a\". If you enter

description "a", the description is a.

•

For Comware commands, you can enter ? to obtain online help or press Tab to complete an

abbreviated command. For more information, see "Using the CLI."

•

The cli command is a Tcl command, so you cannot enter ? to obtain online help or press Tab

to complete an abbreviated command.

•

Successfully executed Comware commands are saved to command history buffers. You can

use the upper arrow or lower arrow key to obtain executed commands.

•

To execute multiple Comware commands in one operation:

 Enter multiple Comware commands separated by semi-colons to execute the commands in

the order they are entered. For example, vlan 2;description Tech.

 Specify multiple Comware commands for the cli command, quote them, and separate

them by a space and a semicolon. For example, cli "vlan 2 ;description Tech".

 Specify one Comware command for each cli command and separate them by a space

and a semicolon. For example, cli vlan 2 ;cli description Tech.

Procedure

1. Enter Tcl configuration view

tclsh

2. Execute Comware commands.

 Execute Comware commands directly.

Command

 Execute Comware commands by using the cli command.

cli command

3. Return from Tcl configuration view to user view.

 tclquit

 quit

Comware 9 extended Tcl API

The Comware 9 extended Tcl API is compatible with the Tcl syntax.

create-cli

Use create-cli to create CLI channels.

Syntax

::comware::create-cli

Usage guidelines

CLI channels are used to execute commands. For more information, see "write-cli."

You can create multiple CLI channels by executing this command multiple times. The created CLI

channels are named cli0, cli1, and so on.

CLI channels are independent of each other and can be regarded as separate command line

terminals.

Examples

# Create a CLI channel.

<Sysname> tclsh

<Sysname-tcl> ::comware::create-cli

Sample output

cli0

destroy-cli

Use destroy-cli to delete a CLI channel.

Syntax

::comware::destroy-cli cli-channel-name

Parameters

cli-channel-name: Specifies an existing CLI channel by its name.

Examples

# Delete CLI channel cli0.

<Sysname> tclsh

<Sysname-tcl> ::comware::destroy-cli cli0

write-cli

Use write-cli to execute a Comware command by using a CLI channel.

Syntax

::comware::write-cli cli-channel-name command

Parameters

cli-channel-name: Specifies an existing CLI channel by its name.

command: Specifies the command to be executed. Quotation marks (") are required before and after

the command. Only one command can be executed at a time.

Usage guidelines

CLI channels do not support interactive commands. A CLI channel executes a command at the

background and does not display any command output information.

By default, a CLI channel executes a command in user view. To execute a command in a different

view, you must execute the commands required to enter the view first.

Examples

# Use CLI channel cli0 to enter system view and change the device name to abc.

<Sysname> tclsh

<Sysname-tcl> ::comware::write-cli cli0 "system-view"

<Sysname-tcl> ::comware::write-cli cli0 "sysname abc"

<Sysname-tcl>

Sample output

<abc-tcl>

execute-shell-cmd

Use execute-shell-cmd to execute Comware commands.

Syntax

::comware::execute-shell-cmd command

Parameters

command: Specifies the commands to be executed. To enter multiple commands, use a space and a

semicolon (;) as the delimiter, for example, "system-view ;sysname test."

Usage guidelines

By default, the commands are executed in user view. To execute a command in a different view,

enter the commands required to enter the view first.

Examples

# Enter system view, change the device name to test, and then ping a remote device.

<Sysname> tclsh

<Sysname-tcl> ::comware::execute-shell-cmd "system-view ;sysname test ;ping

192.168.56.1"

Sample output

<Sysname> system-view

System View: return to User View with Ctrl+Z.

[Sysname] sysname test

[test] ping 192.168.56.1

Ping 192.168.56.1 (192.168.56.1): 56 data bytes, press the char(ASCII 0) to break

56 bytes from 192.168.56.1: icmp_seq=0 ttl=128 time=1.000 ms

...

getmaxslotnumber

Use getmaxslotnumber to get the maximum slot number in the system.

Syntax

::comware::getmaxslotnumber

Returns

The output of this command is a global slot number.

Examples

# Get the maximum slot number in the system.

<Sysname> tclsh

<Sysname-tcl> ::comware::getmaxslotnumbers

Sample output

getminslotnumber

Use getminslotnumber to get the minimum slot number in the system.

Syntax

::comware::getminslotnumber

Examples

# Get the minimum slot number in the system.

<Sysname> tclsh

<Sysname-tcl> ::comware::getminslotnumber

Sample output

transfer

Use transfer to download a file from a server.

Syntax

::comware::transfer protocol server-ip source-file dest-file

vpn-instance-name session-timeout user-name password

Parameters

protocol: Specifies the protocol used to download a file:

•

ftp—Uses FTP.

•

tftp—Uses TFTP.

•

http—Uses HTTP.

server-ip: Specifies the IP address of the remote server.

source-file: Specifies the name of the file to be downloaded.

dest-file: Specifies a name for the downloaded file.

vpn-instance-name: Specifies the VPN instance to which the remote server belongs. This

argument represents the VPN instance name, a case-sensitive string of 1 to 31 characters.

session-timeout: Specifies the timeout for the operation, in seconds. The session timeout must

be a non-negative integer. If the value for this argument is 0, the timeout will be 300 seconds.

user-name: Specifies the username for logging in to the server.

password: Specifies the login password.

Examples

# Download file testfile from an FTP server and save it as flash:/localfile.cfg.

<Sysname> tclsh

<Sysname-tcl> ::comware::transfer ftp 192.168.3.76 testfile flash:/localfile.cfg vpn1 0

admin admin

Using Python

The information, including Python version, displayed after a device enters the Python shell varies by

device model.

About Python

Comware 9 provides a built-in Python interpreter. You can use Python to perform the following tasks:

•

Execute Python scripts to implement automatic device configuration.

•

Enter Python shell to configure the device by using the following items:

 Python 2.7 commands.

 Python 2.7 standard API.

 Extended API. For more information about the extended API, see "Comware 9 extended

Python API."

Executing a Python script

To execute a Python script, use the following command in user view:

python filename

Entering the Python shell

To enter the Python shell from user view, execute the following command:

python

Importing and using the extended Python API

To use the extended Python API, you must first import the API to Python.

Importing the entire extended API and using the API

Procedure

1. Enter the Python shell from user view.

python

2. Import the entire extended API.

import platformtools

3. Execute an extended API function.

platformtools.api

Example

# Use extended API function Transfer to download the test.cfg file from TFTP server

192.168.1.26.

<Sysname> python

>>> import platformtools

>>> platformtools.Transfer('tftp', '192.168.1.26', 'test.cfg', 'flash:/test.cfg',

user='', password='')

<platformtools.Transfer object at 0xb7eab0e0>

Importing an extended API function and using the function

Procedure

1. Enter the Python shell from user view.

python

2. Import an extended API function.

from platformtools import api-name

3. Execute an extended API function.

api-function

Example

# Use extended API function Transfer to download the test.cfg file from TFTP server

192.168.1.26.

<Sysname> python

>>> from platformtools import Transfer

>>> Transfer('tftp', '192.168.1.26', 'test.cfg', 'flash:/test.cfg', user='',

password='')

<platformtools.Transfer object at 0xb7e5e0e0>

Exiting the Python shell

To exit the Python shell, execute the following command in the Python shell.

exit()

Python usage examples

Example: Using a Python script for device configuration

Network configuration

Use a Python script to perform the following tasks:

•

Download configuration files main.cfg and backup.cfg to the device.

•

Configure the files as the main and backup configuration files for the next startup.

Figure 1 Network diagram

Procedure

# Use a text editor on the PC to configure Python script test.py as follows:

#!usr/bin/python

Internet

Device PC

TFTP client TFTP server

192.168.1.200/24 192.168.1.26/24

import platformtools

platformtools.Transfer('tftp', '192.168.1.26', 'main.cfg', 'flash:/main.cfg')

platformtools.Transfer('tftp', '192.168.1.26', 'backup.cfg', 'flash:/backup.cfg')

platformtools.CLI('startup saved-configuration flash:/main.cfg main ;startup

saved-configuration flash:/backup.cfg backup')

# Use TFTP to download the script to the device.

<Sysname> tftp 192.168.1.26 get test.py

# Execute the script.

<Sysname> python flash:/test.py

<Sysname>startup saved-configuration flash:/main.cfg main

Please wait...... Done.

<Sysname>startup saved-configuration flash:/backup.cfg backup

Please wait...... Done.

Verifying the configuration

# Display startup configuration files.

<Sysname> display startup

Current startup saved-configuration file: flash:/startup.cfg

Next main startup saved-configuration file: flash:/main.cfg

Next backup startup saved-configuration file: flash:/backup.cfg

Comware 9 extended Python API

The Comware 9 extended Python API is compatible with the Python syntax.

channel

Use channel to execute Comware 9 CLI commands and create channel objects.

Syntax

channel(command=‘’)

Parameters

command: Specifies the commands to be executed. To enter multiple commands, use a space and a

semicolon (;) as the delimiter. To enter a command in a view other than user view, you must first enter

the commands used to enter the view. For example, you must enter ’system-view ;display

interface brief | include UP’ to execute the display interface brief | include

UP command.

Usage guidelines

This API function supports only Comware 9 commands. It does not support Linux, Python, or Tcl

commands.

The API function is used for automated testing.

The list objects returned by the channel function might contain hexadecimal hidden characters such

as 0x08. To hide the hexadecimal hidden characters, you can use the CLI function instead, or use

the for loop to output the execution result of the channel function, for example:

<Sysname> python

>>> import platformtools

>>> c = platformtools.channel('display vlan')

>>> for value in c:

... print value

...

display vlan

Total VLANs: 13

The VLANs include:

1(default), 2-3, 10, 20, 30, 40, 100-101, 200-202, 300

Returns

Output from the executed commands, in the format of a list object.

Examples

# Display the VLAN information.

<Sysname> python

>>> import platformtools

>>> platformtools.channel('display vlan')

Sample output

['display vlan', ' Total VLANs: 13', ' The VLANs include:', ' 1(default), 2-3, 10, 2

0, 30, 40, 100-101, 200-202, 300, \x08\x08 ', '<Sysname>']

CLI

Use CLI to execute Comware 9 CLI commands and create CLI objects.

Syntax

CLI(command=‘’, do_print=True)

Parameters

command: Specifies the commands to be executed. To enter multiple commands, use a space and a

semicolon (;) as the delimiter. To enter a command in a view other than user view, you must first enter

the commands used to enter the view. For example, you must

enter ’system-view ;local-user test class manage’ to execute the local-user

test class manage command.

do_print: Specifies whether to output the execution result:

•

True—Outputs the execution result. This value is the default.

•

False—Does not output the execution result.

Usage guidelines

This API function supports only Comware commands. It does not support Linux, Python, or Tcl

commands.

Returns

CLI objects

Examples

# Add a local user named test.

<Sysname> python

>>> import platformtools

>>> platformtools.CLI('system-view ;local-user test class manage')

Sample output

<Sysname> system-view

System View: return to User View with Ctrl+Z.

[Sysname] local-user test class manage

New local user added.

<platformtools.CLI object at 0xb7f680a0>

get_error

Use get_error to get the error information from the download operation.

Syntax

Transfer.get_error()

Returns

Error information (if there is no error information, the return is null)

Examples

# Download file test.cfg from TFTP server 1.1.1.1 and get the error information from the operation.

<Sysname> python

>>> import platformtools

>>> c = platformtools.Transfer('tftp', '1.1.1.1', 'test.cfg', 'flash:/test.cfg', user='',

password='')

>>> c.get_error()

Sample output

'Timeout was reached'

get_output

Use get_output to get the output from executed commands.

Syntax

CLI.get_output()

Returns

Output from executed commands

Examples

# Add a local user and get the output from the command.

<Sysname> python

>>> import platformtools

>>> c = platformtools.CLI('system-view ;local-user test class manage', False)

>>> c.get_output()

Sample output

['<Sysname>system-view', 'System View: return to User View with Ctrl+Z.',

'[Sysname]local-user test class manage', 'New local user added.']

get_slot_range

Use get_slot_range to get the supported slot number range.

Syntax

get_slot_range()

Returns

A dictionary object in the format of {'MaxSlot': max-slot-number, 'MinSlot': min-slot-number }. The

max-slot-number argument indicates the maximum slot number. The min-slot-number argument

indicates the minimum slot number.

Examples

# Get the supported slot number range.

<Sysname> python

>>> import platformtools

>>> platformtools.get_slot_range()

Sample output

{'MaxSlot': 16, 'MinSlot': 1}

Transfer

Use Transfer to download a file from a server.

HPE Networking Comware 5960 Switch Series Network Programmability Configuration Guide

Related papers

Other documents