- Table of Contents
-
- 01-Fundamentals Configuration Guide
- 00-Preface
- 01-CLI configuration
- 02-Login management configuration
- 03-RBAC configuration
- 04-FTP and TFTP configuration
- 05-File system management configuration
- 06-Configuration file management configuration
- 07-Software upgrade configuration
- 08-ISSU configuration
- 09-Device management configuration
- 10-Python configuration
- 11-License management(HP不支持)
- 12-Preprovisioning feature configuration
- 13-Automatic configuration
- Related Documents
-
Title | Size | Download |
---|---|---|
10-Python configuration | 78.13 KB |
Comware V7 extended Python API
Importing and using the Comware V7 extended Python API
Comware V7 extended Python API functions
Using Python
Python is an easy to learn, powerful programming language. It has efficient high-level data structures and a simple but effective approach to object-oriented programming. Python's elegant syntax and dynamic typing, together with its interpreted nature, make it an ideal language for scripting and rapid application development in many areas on most platforms.
Comware V7 provides a built-in Python interpreter that supports the following items:
· Python 2.7 commands.
· Python 2.7 standard API.
· Comware V7 extended API. For more information about the Comware V7 extended API, see "Comware V7 extended Python API."
· Python scripts. You can use a Python script to configure the system.
Entering the Python shell
To use Python commands and APIs, you must enter the Python shell.
To enter the Python shell:
Command |
|
Enter the Python shell from user view. |
Executing a Python script
Execute a Python script in user view.
Command |
|
Execute a Python script. |
Exiting the Python shell
Execute this command in the Python shell.
Task |
Command |
Return to user view from the Python shell. |
exit() |
Python usage example
Network requirements
Use a Python script to 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
Configuration procedure
# Use a text editor on the PC to edit Python script test.py as follows:
comware.Transfer('tftp', '192.168.1.26', 'main.cfg', 'flash:/main.cfg')
comware.Transfer('tftp', '192.168.1.26', 'backup.cfg', 'flash:/backup.cfg')
comware.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
<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.
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 V7 extended Python API
The Comware V7 extended Python API is compatible with the Python syntax.
Importing and using the Comware V7 extended Python API
To use the Comware V7 extended Python API, you must import the API to Python.
Use either of the following methods to import and use the Comware V7 extended Python API:
· Use import comware to import the entire API and use comware.API to execute an API.
For example, to use the extended API Transfer to download the test.cfg file from TFTP server 192.168.1.26:
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.Transfer('tftp', '192.168.1.26', 'test.cfg', 'flash:/test.cfg', user='', password='')
<comware.Transfer object at 0x55557bc120>
· Use from comware import API to import an API and use API to execute the API.
For example, to use the extended API Transfer to download the test.cfg file from TFTP server 192.168.1.26:
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> from comware import Transfer
>>> Transfer('tftp', '192.168.1.26', 'test.cfg', 'flash:/test.cfg', user='', password='')
<comware.Transfer object at 0x55557bc0f0>
Comware V7 extended Python API functions
CLI class
CLI
Use CLI to execute Comware V7 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.
Returns
CLI objects
Examples
# Add a local user with the username test.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.CLI('system-view ;local-user test class manage')
<Sysname> system-view
System View: return to User View with Ctrl+Z.
[Sysname] local-user test class manage
New local user added.
<comware.CLI object at 0x55557bc0f0>
get_output
Use get_output to get the output from executed commands.
Syntax
Returns
Output from executed commands
Examples
# Add a local user and get the output from the command.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> c = comware.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']
Transfer class
Transfer
Use Transfer to download a file from a server.
Syntax
Transfer(protocol=‘’, host=‘’, source=‘’, dest=‘’, vrf=‘’, login_timeout=10, user=‘’, password=‘’)
Parameters
protocol: Specifies the protocol used to download a file:
· ftp—Uses FTP.
· tftp—Uses TFTP.
· http—Uses HTTP.
host: Specifies the IP address of the remote server.
source: Specifies the name of the file to be downloaded from the remote server.
dest: Specifies a name for the downloaded file.
login_timeout: Specifies the timeout for the operation, in seconds. The default is 10.
user: Specifies the username for logging in to the server.
password: Specifies the login password.
Returns
Transfer object
Examples
# Download the test.cfg file from TFTP server 192.168.1.26.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.Transfer('tftp', '192.168.1.26', 'test.cfg', 'flash:/test.cfg', user='', password='')
Sample output
<comware.Transfer object at 0x55557bc120>
get_error
Use get_error to get the error information from the download operation.
Syntax
Returns
If there is not error information, None is returned.
Examples
# Download the test.cfg file from TFTP server 1.1.1.1 and get the error information from the operation.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> c = comware.Transfer('tftp', '1.1.1.1', 'test.cfg', 'flash:/test.cfg', user='', password='')
>>> c.get_error()
Sample output
API get_self_slot
get_self_slot
Use get_self_slot to get the slot number of the active MPU in standalone mode, or the slot number of the global active MPU in IRF mode.
Syntax
Returns
In IRF mode, a list object in the format [chassis-number,slot-number] is returned. The chassis-number indicates the member ID of the master. The slot-number indicates the slot number of the global active MPU.
Examples
# In standalone mode, get the slot number of the active MPU.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.get_self_slot()
[-1,17]
API get_standby_slot
get_standby_slot
Use get_standby_slot to get the slot number of the standby MPU in standalone mode.
Use get_standby_slot to get the slot numbers of all global standby MPUs in IRF mode.
Syntax
Returns
In standalone mode, this command returns a list object in the format [[–1,slot-number]]. The slot-number indicates the slot number of the standby MPU. If the switch does not have a standby MPU, [ ] is returned.
In IRF mode, a list object in one of the following formats is returned:
· [ ]—The IRF fabric does not have a global standby MPU.
· [[chassis-number,slot-number]]—The IRF fabric has only one global standby MPU. The chassis-number indicates the member ID of the subordinate switch. The slot-number indicates the slot number of the global standby MPU.
· [[chassis-number1,slot-number1],[chassis-number2,slot-number2],...]—The IRF fabric has multiple global standby MPUs.
Examples
# In standalone mode, get the slot number of the standby MPU.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.get_standby_slot()
Sample output
API get_slot_range
get_slot_range
Use get_slot_range to obtain the supported slot number range.
Syntax
get_slot_range()
Returns
A dictionary object in the format {'MaxSlot': slot-number, 'MinSlot': slot-number}. The slot-number indicates the slot number of the card.
Examples
# Obtain the supported slot number range.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware. get_slot_range()
Sample output
API get_slot_info
get_slot_info
Use get_slot_info to obtain information about a slot.
Syntax
get_slot_info(slot-number)
Returns
A dictionary object in the format {'Slot': slot-number, 'Status': 'Normal/Absent/Fail', 'Chassis': chassis-number, 'Role': 'Master/Standby/IO', 'Cpu': cpu-number}. The chassis-number indicates the member ID of the device. The slot-number indicates the slot number of the card. The cpu-number indicates the number of the CPU.
Examples
# Obtain information about slot 17.
<Sysname> python
Python 2.7.3 (default, Sep 24 2014, 14:37:26)
[GCC 4.4.1] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> import comware
>>> comware.get_slot_info(17)
Sample output
{'Slot': 17, 'Status': 'Normal', 'Chassis': 0, 'Role': 'Master', 'Cpu': 0}