No relevant resource is found in the selected language.

This site uses cookies. By continuing to browse the site you are agreeing to our use of cookies. Read our privacy policy>Search

Reminder

To have a better experience, please upgrade your IE browser.

upgrade

CLI-based Configuration Guide - Basic Configuration

AR500, AR510, AR531, AR550, AR1500, and AR2500 V200R010

This document provides the basic concepts, configuration procedures, and configuration examples in different application scenarios of the Basic configuration supported by the device.
Rate and give feedback:
Huawei uses machine translation combined with human proofreading to translate this document to different languages in order to help you better understand the content of this document. Note: Even the most advanced machine translation cannot match the quality of professional translators. Huawei shall not bear any responsibility for translation accuracy and it is recommended that you refer to the English document (a link for which has been provided).
Making an Index File

Making an Index File

Before USB-based deployment, you must make an index file.

Procedure of Making an Index File

Two methods are available to make an index file of USB-based deployment: use a text file to edit the index file or use eDesk to make an index file.

  • Method 1: Edit the index file on the PC:
    1. Create a text file.
    2. Edit the file based on the index file format.
    3. Rename the file as USB_AR.ini.
    4. Copy the USB_AR.ini file to the root directory of the USB flash drive.
  • Method 2: Use eDesk to make an index file:
    1. Log in to eDesk.
    2. Choose Function > Deployment Assistant. In Select Product, select the corresponding product to access the Config of Udisk Start page, as shown in Figure 4-3.
      Figure 4-3  Config of Udisk Start

    3. On the Config of Udisk Start page, click Add to access the Add Device page, as shown in Figure 4-4. Set related parameters. For details, see Table 4-1.
      Figure 4-4  Add Device

    4. On the Add Device page, click Add Type. In the displayed dialog box Add Type, select the file type, as shown in Figure 4-5.
      Figure 4-5  Add Type

      In the dialog box Add Type, set parameters and click Confirm to save the file type. Return to the Add Device page, and click Confirm to save device information.
    5. On the Config of Udisk Start page, specify a directory for Index File Storage Directory, select the created index data, and click Create Index File, as shown in Figure 4-6.
      Figure 4-6  Create Index File

    6. In the displayed dialog box, set the password used to generate an index file, as shown in Figure 4-7, and then click Confirm.
      Figure 4-7  Set Password

    7. You have created an index file successfully, as shown in Figure 4-8.
      Figure 4-8  Creating an index file successfully

    8. In the displayed dialog box, click Open Folder to access the index file storage directory and obtain the corresponding index file, as shown in Figure 4-9. The USB_AR.ini in the USB_AR.ini_1506498352439.zip indicates the generated index file.
      Figure 4-9  Index file

Index File Format

The index file format is as follows:

BEGIN AR
[USB CONFIG]
SN=
EMS_ONLINE_STATE=
[UPGRADE INFO]
OPTION=
DEVICENUM=
[DEVICEn DESCRIPTION]
OPTION=
ESN=
MAC=
VERSION=
DIRECTORY=
FILENUM=
TYPEn=
FILENAMEn=
FILE_HMACn=
END AR
Table 4-1  Fields in the index file

Field

Description

BEGIN AR

Start tag of the index file. This field cannot be modified.

This field is mandatory.

USB CONFIG

USB flash drive configuration. This field cannot be modified.

This field is mandatory.

SN

Data change time in the format YearMonthDay.HourMinuteSecond.

For example, the value 20110628.080910 indicates 2011-06-28 08:09:10.

This field is mandatory.

NOTE:
The SN field is a USB-based deployment flag. A device has a default USB-based deployment flag. If the USB_AR.ini file exists in the USB flash drive, the device checks whether the default USB-based deployment flag and the SN value in the USB_AR.ini file are the same. If they are different, the USB-based deployment process is triggered. If the deployment succeeds, the value of the default USB-based deployment flag on the device is changed to the SN value in the USB_AR.ini file.

EMS_ONLINE_STATE

Whether the NMS is online:
  • YES: The NMS is online.
  • NO: The NMS is offline.

This field is mandatory.

UPGRADE INFO

Upgrade information header. This field cannot be modified.

This field is mandatory.

OPTION

Upgrade mode flag. The field has a fixed value of AUTO.

This field is mandatory.

DEVICENUM

Number of devices to be upgraded using this index file. The value is an integer that ranges from 1 to 100.

  • To upgrade the software version of one device, set the value of the DEVICENUM field to 1 and use the device's ESN and MAC address.

  • To upgrade software versions of multiple devices of the same series to the same version, set the value of the DEVICENUM field to 1 and use the default ESN and MAC address.

  • To upgrade software versions of multiple devices of the same series to different versions, set the value of the DEVICENUM field to the number of devices to be upgraded and use devices' ESNs and MAC addresses.

This field is mandatory.

DEVICEn DESCRIPTION

Description information header of device n. The value of n is an integer that ranges from 1 to 100.

This field is mandatory.

NOTE:
The value n must be set when you make the index file.

OPTION

Whether USB-based deployment is required for the device. The value OK indicates that USB-based deployment is required, and the value NOK indicates that USB-based deployment is not required.

This field is mandatory.

ESN

Serial number of a device. If the value of this field is DEFAULT, the index file is applicable to all devices. Otherwise, the index file is applicable to a specific device.

This field is mandatory.

NOTE:

If this field is left empty, this field matches all devices.

MAC

MAC address of a device. If the value of this field is DEFAULT, the index file is applicable to all devices. Otherwise, the index file is applicable to a specific device.

This field is mandatory.

NOTE:

If this field is left empty, this field matches all devices.

VERSION

Version number after the upgrade.

This field is mandatory.

NOTE:

The version must be entered correctly. Otherwise, the device will fail to be upgraded.

DIRECTORY

Path for storing deployment files.
  • If the value is DEFAULT, the deployment files are stored in the root directory of the USB flash drive.
  • If the value is /abc, the deployment files are stored in the abc directory.

This field is mandatory.

NOTE:

If this field is left empty, the deployment files are saved in the root directory of the USB flash drive.

On the AR500 series, the deployment file to be loaded must be saved to the root directory of a USB flash drive.

FILENUM

Number of files to be loaded.

If only the system software needs to be loaded, the value of this field is set to 1. If the system software and patch file need to be loaded, the value of this field is set to 2.

This field is mandatory.

TYPEn

Upgrade file type:
  • FACTORY-CONFIG: factory configuration file.
    NOTE:

    If the device supports the voice function and works as a PBX, the configuration file is FACTORY-CONFIG-PBX.

    If the device supports the voice function and works as an AG, the configuration file is FACTORY-CONFIG-AG.

  • SYSTEM-SOFTWARE: system software.
  • SYSTEM-CONFIG: configuration file.
    NOTE:

    If the device supports the voice function and works as a PBX, the configuration file is SYSTEM-CONFIG-PBX.

    If the device supports the voice function and works as an AG, the configuration file is SYSTEM-CONFIG-AG.

  • SYSTEM-PAT: patch file.
  • SYSTEM-LICENSE: license file.
  • SYSTEM-VOICE: voice file.
  • USER-DEFINE: user-defined file.

The value of n is an integer that starts from 1.

This field is mandatory.

FILENAMEn

Upgrade file name. .

The value of n is an integer that starts from 1.

This field is mandatory.

FILE_HMACn

HMAC used to verify a file to be downloaded. The MAC address is a string of 64 characters that is calculated for a specific file using a file checker based on the HMAC-SHA256 algorithm. The key used to calculate the HMAC must be the same as the password configured by the set usb autoupdate password command.

The value of n is an integer that starts from 1.

NOTE:

This field is optional. This field is mandatory after the hmac enable command is executed to enable HMAC check for USB-based deployment.

END AR

End tag of the index file.

This field is mandatory.

Examples

Example 1

You need to create an index file for upgrading one device, and the requirements are as follows:
  • Data is changed at 08:09:10 on June 28, 2013.
  • The NMS is offline.
  • Upgrade is required.
  • The device ESN is 00080123456789 and the MAC address is 0018-0303-1234.
  • The system software system-software01.zip is stored in the root directory of the USB flash drive. The version number is V200R010. The HMAC string is c3caaee8f4f6bd1389f438801e40dad9af30f2fbbe7e8f55121b39c6c16ba488.

The index file that meets the preceding requirements is as follows:

BEGIN AR
[USB CONFIG]
SN=20130628.080910
EMS_ONLINE_STATE=NO
[UPGRADE INFO]
OPTION=AUTO
DEVICENUM=1
[DEVICE1 DESCRIPTION]
OPTION=OK
ESN=00080123456789
MAC=0018-0303-1234
VERSION=V200R010
DIRECTORY=DEFAULT
FILENUM=1
TYPE1=SYSTEM-SOFTWARE
FILENAME1=system-software01.zip
FILE_HMAC1=c3caaee8f4f6bd1389f438801e40dad9af30f2fbbe7e8f55121b39c6c16ba488
END AR

Example 2

You need to create an index file for upgrading multiple devices of the same series to the same software version, and the requirements are as follows:
  • Data is changed at 08:09:10 on June 28, 2013.
  • The NMS is offline.
  • Upgrade is required.
  • The system software system-software01.zip is stored in the root directory of the USB flash drive. The version number is V200R010. HMAC check is not required for any file.

The index file that meets the preceding requirements is as follows:

BEGIN AR
[USB CONFIG]
SN=20130628.080910
EMS_ONLINE_STATE=NO
[UPGRADE INFO]
OPTION=AUTO
DEVICENUM=1
[DEVICE1 DESCRIPTION]
OPTION=OK
ESN=DEFAULT
MAC=DEFAULT
VERSION=V200R010
DIRECTORY=DEFAULT
FILENUM=1
TYPE1=SYSTEM-SOFTWARE
FILENAME1=system-software01.zip
END AR

Example 3

You need to create an index file for two devices with different description information, and the requirements are as follows:
  • Data is changed at 08:09:10 on June 28, 2013.
  • The NMS is offline.
  • The ESN of the first device is 00080123456789. The MAC address is 0018-0303-1234. The name of the system software is V200R010.cc. The version number is V200R010. The configuration file system-config01.zip must be loaded. HMAC check is not required for any file.
  • The ESN of the second device is 66680123456789. The MAC address is 0018-0303-5678. The name of the system software is V200R010.cc. The version number is V200R010. The configuration file system-config02.zip must be loaded. HMAC check is not required for any file.

The index file that meets the preceding requirements is as follows:

BEGIN AR
[USB CONFIG]
SN=20130628.080910
EMS_ONLINE_STATE=NO
[UPGRADE INFO]
OPTION=AUTO
DEVICENUM=2
[DEVICE1 DESCRIPTION]
OPTION=OK
ESN=00080123456789
MAC=0018-0303-1234
VERSION=V200R010
DIRECTORY=DEFAULT
FILENUM=2
TYPE1=SYSTEM-SOFTWARE
FILENAME1=V200R010.zip
TYPE2=SYSTEM-CONFIG
FILENAME2=system-config01.zip
[DEVICE2 DESCRIPTION]
OPTION=OK
ESN=66680123456789
MAC=0018-0303-5678
VERSION=V200R010
DIRECTORY=DEFAULT
FILENUM=2
TYPE1=SYSTEM-SOFTWARE
FILENAME1=V200R010.zip
TYPE2=SYSTEM-CONFIG
FILENAME2=system-config02.zip
END AR

Translation
Download
Updated: 2019-08-09

Document ID: EDOC1100034225

Views: 46488

Downloads: 101

Average rating:
This Document Applies to these Products
Related Documents
Related Version
Share
Previous Next