You are on page 1of 78

OceanStor UDS

V1R2C01LHWS02U1

CLI Command Reference

Issue 01
Date 2017-05-12

HUAWEI TECHNOLOGIES CO., LTD.


Copyright © Huawei Technologies Co., Ltd. 2017. All rights reserved.
No part of this document may be reproduced or transmitted in any form or by any means without prior written
consent of Huawei Technologies Co., Ltd.

Trademarks and Permissions

and other Huawei trademarks are trademarks of Huawei Technologies Co., Ltd.
All other trademarks and trade names mentioned in this document are the property of their respective
holders.

Notice
The purchased products, services and features are stipulated by the contract made between Huawei and the
customer. All or part of the products, services and features described in this document may not be within the
purchase scope or the usage scope. Unless otherwise specified in the contract, all statements, information,
and recommendations in this document are provided "AS IS" without warranties, guarantees or
representations of any kind, either express or implied.

The information in this document is subject to change without notice. Every effort has been made in the
preparation of this document to ensure accuracy of the contents, but all statements, information, and
recommendations in this document do not constitute a warranty of any kind, express or implied.

Huawei Technologies Co., Ltd.


Address: Huawei Industrial Base
Bantian, Longgang
Shenzhen 518129
People's Republic of China

Website: http://www.huawei.com
Email: support@huawei.com

Issue 01 (2017-05-12) Huawei Proprietary and Confidential i


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference About This Document

About This Document

Overview
This document describes command-line interface (CLI) commands provided by Huawei
OceanStor UDS Massive Storage System (UDS for short). Developers and users can use the
CLI commands to manage and maintain UDS.

Intended Audience
This document is intended for:
l Technical support engineers
l Maintenance engineers

Symbol Conventions
The symbols that may be found in this document are defined as follows:

Symbol Description

Alerts you to a high risk hazard that could, if not avoid, result
in serious injury or death.

Alerts you to a medium or low risk hazard that could, if not


avoided, result in moderate or minor injury.

Alerts you to a potentially hazardous situation that could, if


not avoided, result in equipment damage, data loss,
performance deterioration, or unanticipated results.

Provides a tip that may help you solve a problem or save time.

Provides additional information to emphasize or supplement


important points in the main text.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential ii


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference About This Document

Change History
Changes between document issues are cumulative. The latest document issue contains all the
changes made in earlier issues.

Issue 01 (2016-09-15)
This issue is the first official release.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential iii


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference Contents

Contents

About This Document.....................................................................................................................ii


1 CLI Instructions............................................................................................................................. 1
1.1 Prerequisites....................................................................................................................................................................2
1.2 Logging In to the CLI..................................................................................................................................................... 2
1.3 Format Conventions....................................................................................................................................................... 4
1.4 Categories of CLI Commands........................................................................................................................................ 4
1.5 Error Messages............................................................................................................................................................... 5
1.6 System Constraints......................................................................................................................................................... 5

2 Query Commands..........................................................................................................................6
2.1 show storage capacity..................................................................................................................................................... 8
2.2 show smart disk number................................................................................................................................................. 9
2.3 show version................................................................................................................................................................... 9
2.4 show license..................................................................................................................................................................10
2.5 show performance.........................................................................................................................................................10
2.6 show rebalance tasks.................................................................................................................................................... 12
2.7 show ftp........................................................................................................................................................................ 12
2.8 show tftp....................................................................................................................................................................... 13
2.9 show tomcatAccessWhitelist........................................................................................................................................ 13
2.10 show billfilter..............................................................................................................................................................14
2.11 show AccessLogOpen.................................................................................................................................................15
2.12 show OSCDisableTlsvOnePointOne.......................................................................................................................... 15
2.13 show billingprefix.......................................................................................................................................................16
2.14 show bssdomain..........................................................................................................................................................16
2.15 show billisforbucket................................................................................................................................................... 17
2.16 show bssip...................................................................................................................................................................17
2.17 show mgmtdatabackup............................................................................................................................................... 18
2.18 show route list.............................................................................................................................................................19
2.19 show alarmInfoSwitch................................................................................................................................................ 19
2.20 show forbidcbc........................................................................................................................................................... 20
2.21 show smninfo..............................................................................................................................................................20
2.22 show bucketblacklist...................................................................................................................................................21
2.23 show coexiststatus...................................................................................................................................................... 22

Issue 01 (2017-05-12) Huawei Proprietary and Confidential iv


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference Contents

2.24 show newclusterendpoint........................................................................................................................................... 22


2.25 show privateregion..................................................................................................................................................... 23
2.26 show taggingenable.................................................................................................................................................... 23

3 Setting Commands...................................................................................................................... 25
3.1 start manual shutdown.................................................................................................................................................. 27
3.2 start manual wakeup..................................................................................................................................................... 28
3.3 change bannerinfo.........................................................................................................................................................29
3.4 change billisforbucket...................................................................................................................................................30
3.5 change ftp..................................................................................................................................................................... 31
3.6 change tftp.................................................................................................................................................................... 32
3.7 change responseNamespace..........................................................................................................................................33
3.8 change bssip..................................................................................................................................................................35
3.9 change tomcatAccessWhitelist..................................................................................................................................... 36
3.10 change jettytime..........................................................................................................................................................37
3.11 change billingprefix.................................................................................................................................................... 38
3.12 change billfilter...........................................................................................................................................................39
3.13 change regioncopy...................................................................................................................................................... 40
3.14 change bssdomain.......................................................................................................................................................41
3.15 change oschttpenable.................................................................................................................................................. 43
3.16 change poehttpenable................................................................................................................................................. 44
3.17 change iptablesrule..................................................................................................................................................... 45
3.18 change mgmtdatabackup............................................................................................................................................ 46
3.19 change accesslogopen.................................................................................................................................................48
3.20 change OSCDisableTlsvOnePointOne....................................................................................................................... 49
3.21 change garbagebuckettime..........................................................................................................................................50
3.22 change websiteloc.......................................................................................................................................................50
3.23 start import license......................................................................................................................................................51
3.24 start active license.......................................................................................................................................................52
3.25 add route..................................................................................................................................................................... 53
3.26 delete route................................................................................................................................................................. 54
3.27 change alarmInfoSwitch............................................................................................................................................. 55
3.28 change reptaskscaninterval......................................................................................................................................... 56
3.29 change forbidcbc.........................................................................................................................................................57
3.30 change smninfo...........................................................................................................................................................58
3.31 change customizedomainenable................................................................................................................................. 60
3.32 change udscryptotype................................................................................................................................................. 60
3.33 change obssvcpassword.............................................................................................................................................. 61
3.34 change bucketblacklist................................................................................................................................................62
3.35 change storageclassenable.......................................................................................................................................... 64
3.36 change coexiststatus................................................................................................................................................... 64
3.37 change newclusterendpoint.........................................................................................................................................66
3.38 change privateregion...................................................................................................................................................67

Issue 01 (2017-05-12) Huawei Proprietary and Confidential v


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference Contents

3.39 change taggingenable................................................................................................................................................. 68


3.40 change bucketconcurrency..........................................................................................................................................69
3.41 change globalscanbucketflow.....................................................................................................................................70

Issue 01 (2017-05-12) Huawei Proprietary and Confidential vi


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 1 CLI Instructions

1 CLI Instructions

After logging in to the command-line interface (CLI), you can manage and maintain
HUAWEI OceanStor Universal Distributed Storage massive storage system (the UDS for
short). The usage and use skills of the CLI can help you use the CLI more easily and quickly.
1.1 Prerequisites
1.2 Logging In to the CLI
1.3 Format Conventions
1.4 Categories of CLI Commands
1.5 Error Messages
1.6 System Constraints

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 1


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 1 CLI Instructions

1.1 Prerequisites
Before performing CLI operations, you need to prepare some data. The following table lists
the data that you need to prepare.

Table 1-1 Data that you need to prepare before CLI operations
Category Parameter Example

Parameters used for logging Floating IP address of the 172.16.0.1


in to the active OMS management plane

User name cli

Password Uds6200!

1.2 Logging In to the CLI


After logging in to the CLI, you can query, set, manage, and maintain the UDS. On the
maintenance terminal, you can log in to the CLI using an SSH tool such as PuTTY.

Operation Guide
NOTE

This document uses PuTTY as an example. You can download PuTTY from http://
www.chiark.greenend.org.uk.

Step 1 Connect the maintenance terminal to the storage system using a network cable and ensure that
the IP address of the maintenance terminal and the floating IP address of the storage system
management plane reside on the same network segment
Step 2 Run PuTTY. The PuTTY Configuration dialog box is displayed, as shown in the following
figure.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 2


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 1 CLI Instructions

Step 3 Select Session. In the Host Name (or IP address) text box in the Specify your connection
by host name or IP address area, enter the floating IP address of the management plane. IP
address 172.16.0.1 is used as an example. Select SSH for Connection type.
Step 4 Click Open. The CLI window is displayed asking you to log in. Enter the user name and
password as prompted. If the following information is displayed, you have successfully
logged in to the CLI:
login as: cli

Authorized users only. All activity may be monitored and reported.

Using keyboard-interactive authentication.


password:
Last login: Tue Jan 14 17:36:02 2014 from 172.16.0.1

Authorized users only. All activity may be monitored and reported.

cli@OMS02:~>

Step 5 Run the following command to disable the automatic exit function of PuTTY.
TMOUT=0

----End

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 3


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 1 CLI Instructions

NOTICE
For account security, change the password upon your initial login. For details about how to
change the password, see section "Managing System Users" in the OceanStor UDS
Administrator Guide.

1.3 Format Conventions


You are required to follow the format conventions when you use the CLI commands.

Typical command formats are:

show storage capacity

On the CLI, a command consists of several fields. Fields are described as follows:

l First field: operation that you want to perform, for example, change and show.
l Second field: object of an operation, for example, a version and license.
l Other fields: other parameters required.

Table 1-2 describes the format conventions of CLI commands.

Table 1-2 Format conventions


Format Description

Boldface The keywords of a command line are in


boldface.

Italic Command arguments are in italics.

<> Items in angle brackets (< >) are mandatory.

For example, in the show performance <service> command:

l show performance keeps unchanged.


l The item in angle brackets (< >) must be selected.
The correct command is:
cli@OMS01:~> show performance OBS

1.4 Categories of CLI Commands


Commands that are commonly used in routine maintenance of the UDS are provided using the
CLI to improve the maintenance efficiency and standardize operation and maintenance
service (OMS) interfaces.

CLI commands are divided into query commands and setting commands in terms of
functions.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 4


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 1 CLI Instructions

1.5 Error Messages


Error messages indicate errors occurred when users input commands and display correct
commands to help users locate the errors and modify the commands accordingly.
If a user runs a command whose character or format is incorrect, the system displays an error
message and provides the help information in the error message to help the user locate the
error and modify the command. In the following example, the third parameter of the
command is incorrect. When this command is executed, the following error message and help
information are displayed:
cli@OMS01:~> show storage caaacity
ERROR:command is invalid!
Usage: show <option>
Options:
storage capacity : show storage capacity

1.6 System Constraints


After logging in to the CLI, you can manage and maintain the UDS. Currently, the CLI of the
UDS supports basic functions only, and faces the following constraints:
l Command completion by pressing Tab is not supported.
l Shortcut keys are not supported.
l Unauthorized operations such as directory switch, and file and directory modification or
deletion are not allowed.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 5


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2 Query Commands

Query commands are used to query the capacity, version, and performance of the UDS.
2.1 show storage capacity
2.2 show smart disk number
2.3 show version
2.4 show license
2.5 show performance
2.6 show rebalance tasks
2.7 show ftp
2.8 show tftp
2.9 show tomcatAccessWhitelist
2.10 show billfilter
2.11 show AccessLogOpen
2.12 show OSCDisableTlsvOnePointOne
2.13 show billingprefix
2.14 show bssdomain
2.15 show billisforbucket
2.16 show bssip
2.17 show mgmtdatabackup
2.18 show route list
2.19 show alarmInfoSwitch
2.20 show forbidcbc
2.21 show smninfo
2.22 show bucketblacklist
2.23 show coexiststatus

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 6


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.24 show newclusterendpoint


2.25 show privateregion
2.26 show taggingenable

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 7


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.1 show storage capacity


Function
The show storage capacity command is used to view the capacity information of the UDS,
including:
l Total capacity
l Available capacity
l Used capacity
l Capacity usage

Format
show storage capacity

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show storage capacity
Total storage capacity | Available storage capacity | Used storage capacity |
Storage capacity usage
69.113 TB | 69.112 TB | 502.722 MB |
<0.01%

System Response
You can view the capacity usage of the UDS by running this command. The capacity is
displayed as follows:
1. Capacity display rules:
– When the capacity is greater than 1 EB, the capacity is displayed in the unit of EB
and is rounded to three decimal places.
– When the capacity is greater than 1 PB but less than 1 EB, the capacity is displayed
in the unit of PB and is rounded to three decimal places.
– When the capacity is greater than 1 TB but less than 1 PB, the capacity is displayed
in the unit of TB and is rounded to three decimal places.
– When the capacity is greater than 1 GB but less than 1 TB, the capacity is displayed
in the unit of GB and is rounded to three decimal places.
– When the capacity is greater than 1 MB but less than 1 GB, the capacity is
displayed in the unit of MB and is rounded to three decimal places.
– When the capacity is less than 1 MB, <1M is displayed.
2. Capacity usage display rules:

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 8


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

When the capacity usage is less than 0.01%, <0.01% is displayed, and the actual
capacity usage is displayed and is rounded to two decimal places.

2.2 show smart disk number


Function
The show smart disk number command is used to view information about smart disks of the
UDS, including:
l Number of smart disks
l Number of faulty smart disks

Format
show smart disk number

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show smart disk number
Total number of smart disks | Number of faulty smart disks
26 | 0

2.3 show version


Function
The show version command is used to view the version of the UDS.

Format
show version

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show version
V1R2C01LHWS02U1

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 9


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.4 show license


Function
The show license command is used to view information about the license and equipment
serial number (ESN).

Format
show license

Parameters
None

Usage Guidelines
None

Examples
1. No license is active.
cli@OMS01:~> show license
The license is not activated.
ESN
753B5B64B69F898AF4141280BB7A8A7643B268DB
D53C1BC6CBFE78E4D024AA6878F7FC1511452753

2. At least one license is active.


cli@OMS01:~> show license
Feature Name | Used | Available | Expiration Time
MDCReplication | 1 active 2 standby | 1 active 2 standby | PERMANENT
Compression | Enable | Enable | PERMANENT
Deduplication | Enable | Enable | PERMANENT
Capacity | 0 TB | 2100 TB | PERMANENT

ESN
753B5B64B69F898AF4141280BB7A8A7643B268DB
D53C1BC6CBFE78E4D024AA6878F7FC1511452753

System Response
1. Two ESNs are displayed after this command is executed. The first one is the ESN of
OMS 01 and the second one is that of OMS 02.
2. If a license is a permanent license, that is, the license never expires, PERMANENT is
displayed.

2.5 show performance


Function
The show performance command is used to view the performance indicators of the UDS.
Only service performance indicators can be queried. Each performance result that you query
is obtained in the last five minutes. The performance result includes:

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 10


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

l Total number of service access attempts


l Service access failure rate
l Number of PUT attempts
l Number of PUT failures
l Number of PUT failures due to client errors
l Number of GET attempts
l Number of GET failures
l Number of GET failures due to client errors
l Number of DELETE attempts
l Number of DELETE failures
l Number of DELETE failures due to client errors

Format
show performance <service type>

Parameters
Parameter Description Value

service type Performance type Only OBS is supported.

Usage Guidelines
None

Examples
cli@OMS01:~> show performance OBS
--Fri Mar 7 10:29:30 GMT-8 2014--
Number of service accesses (period: 5min) | Service access failure rate (%)
(period: 5min)
0.00 |
0.00

Number of PUT operations (period: 5min) : 0.00


Number of PUT failures (period: 5min) : 0.00
Number of PUT failures due to client errors (period: 5min) : 0.00

Number of GET operations (period: 5min) : 0.00


Number of GET failures (period: 5min) : 0.00
Number of GET failures due to client errors (period: 5min) : 0.00

Number of DELETE operations (period: 5min) : 0.00


Number of DELETE failures (period: 5min) : 0.00
Number of DELETE failures due to client errors (period: 5min) : 0.00

-----------------------------------------------------------------------

System Response
l The show performance command will be executed every five minutes.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 11


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

l You can press CTRL+C to stop the performance indicator query.

2.6 show rebalance tasks


Function
The show rebalance tasks command is used to view information about all rebalance tasks
(data migration tasks) of a storage cluster, including:

l Rebalance task progress


l Task receiving time
l Task start time
l Task end time
l Task description

Format
show rebalance tasks

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show rebalance tasks
process | task recv time | task start time |
task end time |
desc

1.0 | 31 Dec 2013 07:56:36 UTC | 31 Dec 2013 07:57:32 UTC | 31


Dec 2013 07:57:33 UTC | manual rebalance without targetxml; The
initialization of cluster partitions for the first time has been completed

2.7 show ftp


Function
The show ftp command is used to view the ftp service status, closed or open.

Format
show ftp

Parameters
None

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 12


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Usage Guidelines
None

Examples
cli@OMS01:~> show ftp
SUCCESS:get ftp switch info success! the value is:true

System Response
true means the relevant service is open.
false means the relevant service is closed.

2.8 show tftp


Function
The show tftp command is used to view the tftp service status, closed or open.

Format
show tftp

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show tftp
SUCCESS:get tftp switch info success! the value is:false

System Response
true means the relevant service is open.
false means the relevant service is closed.

2.9 show tomcatAccessWhitelist


Function
Theshow tomcatAccessWhitelist command is used to view a whitelist of IP addresses that
are allowed to access the Tomcat service.

Format
show tomcatAccessWhitelist

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 13


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Parameters
None

Usage Guidelines
None

Examples
A user configures a whitelist.
cli@OMS01:~> show tomcatAccessWhitelist
User had configured ip whitelist:[127.0.0.1].

A user does not configure a whitelist.


cli@OMS01:~> show tomcatAccessWhitelist
User had not configured ip whitelist.

System Response
l The output is a whitelist of IP addresses configured by a user, which are allowed to
access the Tomcat service.If the user does not configure a whitelist, the message stating
that the user does not configure a whitelist will be displayed.

2.10 show billfilter


Function
The show billfilter command is used to check the prefix field of the domainname whose
CDR is not generated in UDS.

Format
show billfilter

Parameters
None

Usage Guidelines
None

Examples
OMS02:~ # show billfilter
bill filter prefix = domainname:shadow_,op_

System Response
The field behind domainname indicates the prefix field of the domainname whose CDR is
not generated. In this example, CDRs of domainnames that are start with shadow_ and op_
are not generated.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 14


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.11 show AccessLogOpen


Function
show AccessLogOpen command is used to show whether the access log output service is
open or not.

Format
show AccessLogOpen

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show AccessLogOpen
AccessLogOpen = false

System Response
true means the service is opened.

false means the service is closed.

2.12 show OSCDisableTlsvOnePointOne


Function
The show OSCDisableTlsvOnePointOne command is used to check the "TLSv1.1" protocol
disabled or not.

Format
show OSCDisableTlsvOnePointOne

Parameters
None

Usage Guidelines
None

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 15


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Examples
cli@OMS01:~> show OSCDisableTlsvOnePointOne
OSCDisableTlsvOnePointOne = true

System Response
In this example, True means "TLSv1.1" protocol is disabled.

2.13 show billingprefix


Function
The show billingprefix command is used to view CDR file prefixes in UDS and carrier
information in CDRs.

Format
show billingprefix

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show billingprefix
bill file prefix = OTC

System Response
The billingprefix value is displayed. For details about the value, see change billingprefix. If
no bill file prefix configured! is displayed, this parameter is not configured. The default
value is HWS.

2.14 show bssdomain


Function
The show bssdomain command is used to view the bitmap of the CDR format control switch
in UDS.

Format
show bssdomain

Parameters
None

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 16


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Usage Guidelines
None

Examples
cli@OMS01:~> show bssdomain
BSSDomain = 000000000000000000001000

System Response
The bitmap of the CDR format control switch in UDS is displayed. For details about each bit,
see the parameter description of the change bssdomain command. If BSSDomain = 0 is
displayed, this parameter is not configured. The value of each bit is 0.

2.15 show billisforbucket


Function
The show billisforbucket command is used to check whether storage-specific CDRs are
generated based on buckets in UDS.

Format
show billisforbucket

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show billisforbucket
storage bill for bucket = false

System Response
Whether storage-specific CDRs are generated based on buckets is displayed. true indicates
that storage-specific CDRs are generated based on buckets. Otherwise, storage-specific CDRs
are generated based on users.

2.16 show bssip


Function
The show bssip command is used to view the IP address and port ID of the business support
system (BSS).

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 17


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Format
show bssip

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show bssip
BSS IP is 172.16.128.8:8090

System Response
The configured IP address and port ID of the BSS in UDS are displayed. The IP address is
used for message interaction between the BSS and UDS.

2.17 show mgmtdatabackup


Function
The show mgmtdatabackup command is used to check the switch status of management
data-backup.

Format
show mgmtdatabackup

Parameters
None

Usage Guidelines
None

Examples
cli@OMS02:~> show mgmtdatabackup
SUCCESS:MgmtData backup switch status is off.

System Response
MgmtData backup switch status is off, or MgmtData backup switch status is on.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 18


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.18 show route list


Function
The show route list command is used to query the router list that a CLI user has added.

Format
show route list

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show route list
Destination Gateway Genmask
172.29.37.0 192.168.31.254 255.255.255.0
172.29.38.0 192.168.31.254 255.255.255.0
172.29.39.0 192.168.31.254 255.255.255.0

System Response
This command is used to query the router list a CLI user has added.

Destination: router destination address.

Gateway: gateway.

Genmask: specified net mask of an added router.

2.19 show alarmInfoSwitch


Function
The show alarmInfoSwitch command is used to check the switch status of TRAP alarm
information.

Format
show alarmInfoSwitch

Parameters
None

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 19


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Usage Guidelines
None

Examples
cli@OMS02:~> show alarmInfoSwitch
SwtichInfo:on

System Response
TRAP alarm information switch status is off, or TRAP alarm information switch status is on.

2.20 show forbidcbc


Function
The show forbidcbc command is used to query the status of the cipher block chaining (CBC)
mode of SSH.

Format
show forbidcbc

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show forbidcbc
forbidcbc status = on

System Response
If the command output is forbidcbc status = off, the CBC mode of SSH is not forbidden and
the system can be connected in CBC mode. If the command output is forbidcbc status = on,
the CBC mode of SSH is forbidden and the system cannot be connected in CBC mode.

2.21 show smninfo


Function
The show smninfo command is used to query the status and address of the SMN.

Format
show smninfo

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 20


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show smninfo smn_connection=enable smn_address=https://172.16.0.4:443

System Response
l Status of the SMN. smn_connection=enable indicates that the SMN has been enabled.
smn_connection=disable indicates the SMN has not been enabled.
l IP address of the SMN.
l smn_address=https://172.16.0.4:443 indicates that the IP address of the SMN is
172.16.0.4, HTTPS is used, and the communication port is 443.

2.22 show bucketblacklist


Function
Views the buckets that are added to a blacklist in the storage system.

Format
show bucketblacklist

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show bucketblacklist
BUCKET_BLACKLIST:
bucket01
bucket02

System Response
In the output, BUCKET_BLACKLIST: is the fixed content and each row following it
represents a blacklisted bucket.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 21


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

2.23 show coexiststatus


Function
Views the service forwarding status of the system.

Format
show coexiststatus

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show coexiststatus
coExiststatus = 1

System Response
In the output, coExistStatus=1 indicates that the current system uses an IP address to forward
services; coExistStatus=2 indicates that the current system uses a region domain name to
forward services; if coExistStatus=0 or the result is empty, the service forwarding function is
not enabled.

2.24 show newclusterendpoint


Function
Queries the target cluster address used for service forwarding.

Format
show newclusterendpoint

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show newclusterendpoint
newClusterEndPoint = 127.0.0.2

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 22


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

System Response
In the output, newClusterEndPoint = 127.0.0.2 indicates that the configured IP address is
127.0.0.2.

2.25 show privateregion


Function
The show privateregion command is used to view the private region list of the current node.

Format
show privateregion

Parameters
None

Usage Guidelines
None

Examples
cli@OMS01:~> show privateregion private region list:region1,region2,region3

System Response
In the output, private region list: is the fixed content and is followed by private regions. The
private regions are comma-separated. There can be no, one, or multiple private regions.

2.26 show taggingenable


Function
The show taggingenable command is used to view the status of the tagging service: enabled
or disabled.

Format
show taggingenable

Parameters
None

Usage Guidelines
None

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 23


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 2 Query Commands

Examples
cli@OMS01:~> show taggingenable
TaggingEnable = true

System Response
If true is displayed in the command output, the service has been enabled. If false is displayed,
the service has been disabled.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 24


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3 Setting Commands

Setting commands are used to operate the UDS, including system power-on and power-off,
and notification configurations.
3.1 start manual shutdown
3.2 start manual wakeup
3.3 change bannerinfo
3.4 change billisforbucket
3.5 change ftp
3.6 change tftp
3.7 change responseNamespace
3.8 change bssip
3.9 change tomcatAccessWhitelist
3.10 change jettytime
3.11 change billingprefix
3.12 change billfilter
3.13 change regioncopy
3.14 change bssdomain
3.15 change oschttpenable
3.16 change poehttpenable
3.17 change iptablesrule
3.18 change mgmtdatabackup
3.19 change accesslogopen
3.20 change OSCDisableTlsvOnePointOne
3.21 change garbagebuckettime
3.22 change websiteloc

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 25


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.23 start import license


3.24 start active license
3.25 add route
3.26 delete route
3.27 change alarmInfoSwitch
3.28 change reptaskscaninterval
3.29 change forbidcbc
3.30 change smninfo
3.31 change customizedomainenable
3.32 change udscryptotype
3.33 change obssvcpassword
3.34 change bucketblacklist
3.35 change storageclassenable
3.36 change coexiststatus
3.37 change newclusterendpoint
3.38 change privateregion
3.39 change taggingenable
3.40 change bucketconcurrency
3.41 change globalscanbucketflow

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 26


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.1 start manual shutdown


Function
The start manual shutdown command is used to shut down a device manually. After this
command is executed, services running on the device are stopped, but the device is powered
on (in standby mode). Running this command can shut down all nodes of the UDS and
UDSNs.

Format
start manual shutdown <node>

Parameters
Parameter Description Value

node Node that you want to shut Possible values are all or
down nodename, where:
l all: all nodes
l nodename: name of a
specific node

Usage Guidelines
A power-off task must be executed in the following scenarios:
l An operator receives an outage notification.
l Power is supplied to the UDS using an uninterruptible power supply (UPS).
l The UDS needs to be maintained.

NOTICE
Device power-off interrupts all services. Therefore, exercise caution when powering off the
UDS. After powering off the UDS, you cannot perform an interruption. You can power on the
UDS only after all nodes are powered off.

Examples
1. Shut down all nodes.
cli@OMS01:~> start manual shutdown all
******************************************************************
Warning, UDS cluster will shutdown!
******************************************************************
Do you want to continue?[yes/no]:yes

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 27


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Please confirm again![yes/no]:yes


System is going to shutdown system ....
Start to stop service for x86 nodes, please wait for minutes ...
............................................................................
Start to shutdown x86 nodes, please wait for minutes ...
............................................................................
Start to stop service for sod nodes, please wait for minutes ...
............................................................................
******************************************************************
SUCCESS: OMS02 OSC01 UDSN_0205
All other nodes shutdown success.
******************************************************************
Do you want to shutdown this node?[yes/no]:yes
System is going to shutdown

2. Shut down a UDSN.


cli@OMS01:~> start manual shutdown UDSN_0205
******************************************************************
UDSN_0205 will power off!
******************************************************************
Do you want to continue?[yes/no]:yes
Start to power off.
Start power off udsn nodes, please wait minutes ...
SUCCESS: UDSN_0205

System Response
If a node fails to be shut down, see section "Device Power-On and Power-Off" in the
OceanStor UDS Administrator Guide.

3.2 start manual wakeup


Function
The start manual wakeup command is used to wake up devices manually. For UDSNs in the
standby state, you can use this command to wake up them in batches. This saves time and
prevents exceptions when devices are powered on. Running this command can wake up only
UDSNs. (For A-Nodes, you cannot use this command but manually wake up them.)

Format
start manual wakeup <node>

Parameters
Parameter Description Value

node UDSN that you want to Possible values are all or


wake up nodename, where:
l all: all UDSNs
l nodename: name of a
specific UDSN

Usage Guidelines
l After a node is shut down using start manual shutdown, the node can be woken up 30
minutes later.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 28


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

l Before waking up nodes, you must manually wake up an OMS node. For details, see
section "Device Power-On and Power-Off" in the OceanStor UDS Administrator Guide.
l After running tabdump hosts | grep UDSN | cut -d',' -f1 | sed 's/\"//g' | sort -u on the
active OMS, you can view all UDSN names.

Examples
1. Wake up all UDSNs.
cli@OMS01:~> start manual wakeup all
******************************************************************
UDS cluster will power on!
******************************************************************
Do you want to continue?[yes/no]:yes
Start to power on.
Start power on udsn nodes, please wait minutes ...
SUCCESS: UDSN_0101 UDSN_0102

2. Wake up a specific UDSN.


cli@OMS01:~> start manual wakeup UDSN_0101
******************************************************************
UDSN_0101 will power on!
******************************************************************
Do you want to continue?[yes/no]:yes
Start to power on.
Start power on udsn nodes, please wait minutes ...
SUCCESS: UDSN_0101

System Response
If a node fails to be woken up, see section "Device Power-On and Power-Off" in the
OceanStor UDS Administrator Guide.

3.3 change bannerinfo


Function
The change bannerinfo command is used to view system authorization messages. After a
user logs in to the storage system, the system displays messages indicating authorized users
and correct scenarios of the system, and consequences and liabilities the user must undertake
if the user utilizes the system without authorization.

Format
change bannerinfo <noticeinfo>

Parameters
Parameter Description Value

noticeinfo System authorization This value is a legal


information that you want to character string.
set

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 29


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
l The system authorization information must be less than 1024 bytes.
l The system authorization information must be a legal character string that is enclosed in
quotation marks. For example:
change bannerinfo "Authorized users only. All activity may be monitored and
reported."
l If the system authorization information is a null character string (""), the user resets the
system authorization information to the default one "Authorized users only. All activity
may be monitored and reported."
l Currently, the system supports letters, digits, space and the following special characters:
~@#%^&()_+-={}<>:;,.?'/|

Examples
cli@OMS01:~> change bannerinfo "Welcome to HUAWEI OceanStor UDS"
SUCESS:change banner info success!

System Response
After the system authorization information is modified, you can view the new system
authorization information using SSH.
OMS01:~ # ssh cli@172.16.0.1
Warning: Permanently added '172.16.0.1' (ECDSA) to the list of known hosts.

Authorized users only. All activity may be monitored and reported.

password:
Welcome to HUAWEI OceanStor UDS

3.4 change billisforbucket


Function
The change billisforbucket command is used to set the generation mode of storage-specific
CDRs: based on buckets or users.

Format
change billisforbucket <noticeinfo>

Parameters
Parameter Description Value

noticeinfo CDR generation mode: true/false


true: CDRs are generated
based on buckets.
false: CDRs are generated
based on users.
Default value: false

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 30


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
The command is a valid character string that contains true or false:
change billisforbucket true

Or
change billisforbucket false

Example
cli@OMS01: > change billisforbucket false
SUCCESS:change BillIsForBucket info success!

System Response
After the modification, you can run the /opt/obs/obsconf/obs_sod.properties command to
check that the value of parameter bill_is_for_bucket in the configuration file has been
changed to the one in the command.
# grep bill_is /opt/obs/obsconf/obs_sod.properties
bill_is_for_bucket = false

3.5 change ftp


Function
The change ftp command is used to enable or disable the FTP service.

Format
change ftp <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Service status. true: The true/false


service is enabled. false:
The service is disabled.
Default:true

Usage Guidelines
l Exercise caution when disable the FTP protocol because this highly risky operation may
result in patch installation and upgrade failures.
l The FTP protocol has security risks.You are advised to enable it before using it and
disable it after using it.
l The command is a valid character string that contains true or false:
change ftp true

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 31


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

or
change ftp false

Example
cli@OMS01: > change ftp true
Warning: This operation will enable the ftp service.
The ftp service has security risks and is not recommended.
Do you want to continue?(yes/no):yes
SUCCESS:change ftp switch info success!

System Response
After the modification, you can check that the value of the service in Tbl_Ftp_Switch has
been changed to the one in the command.
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_Ftp_Switch\";"
Password for user gaussdba:
ID | VALUE
------+-------
tftp | false
ftp | true
(2 rows)

NOTE

Security of FTP services is low. Users can disable them to improve system security of the UDS.

3.6 change tftp


Function
The change tftp command is used to enable or disable the TFTP service.

Format
change tftp <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Service status. true: The true/false


service is enabled. false:
The service is disabled.
Default:true

Usage Guidelines
l Exercise caution when disable the FTP protocol because this highly risky operation may
result in patch installation and upgrade failures.
l The TFTP protocol has security risks. You are advised to enable it before using it and
disable it after using it.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 32


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

l The command is a valid character string that contains true or false:


change tftp true
or
change tftp false

Example
cli@OMS01: > change tftp true
Warning: This operation will enable the tftp service.
The tftp service has security risks and is not recommended.
Do you want to continue?(yes/no):yes
SUCCESS:change tftp switch info success!

System Response
After the modification, you can check that the value of the service in Tbl_Ftp_Switch has
been changed to the one in the command.
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_Ftp_Switch\";"
Password for user gaussdba:
ID | VALUE
------+-------
tftp | true
ftp | false
(2 rows)

NOTE

Security of TFTP services is low. Users can disable them to improve system security of the UDS.

3.7 change responseNamespace


Function
The change responseNamespace command is used to set the namespacein the XML response
to an S3 request. Namespace is used to avoid conflicts in the XML element names. Generally,
the parameter value is set to the namespace of the site during the live network deployment and
will not be changed.

Format
change responseNamespace <namespace>

Parameters
Parameter Description Value

namespace namespace character string The value is a string


to be set in the XML containing 1 to 511
response to an S3 request characters.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 33


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
The command contains valid strings without spaces or the Table key, for example: change
responseNamespace http://obs.otc.t-systems.com/doc/2015-06-30/
The value of responseNamespace is the namespace of the XML in the response message body
of the S3 API. The following lists the response message body for sending object requests in a
list bucket:

Example
cli@OMS01: > change responseNamespace http://obs.myhwclouds.com/doc/2006-06-30
SUCCESS:change response namespace success!

System Response
The change of the namespace in the XML response to an S3 request takes effect only when
you log in to each access node and restart the OSC and OIS process. The details are as
follows:

Restarting the OSC process interrupts services on the active access node. Therefore, process
nodes in batches, and the process interval must be at least 3 minutes in case of system service
interruption.
1. Use PuTTY to log in to the active OMS.
Account opadmin, the password (the default password is Uds6200!), and IP address of
the management plane are used for the login. Run the su - root command to switch to the
root account.
2. Run the following command to ensure that the configuration items in the configuration
file on the node have been changed successfully:
OMS01:~ # cat /opt/obs/obsconf/obs_sod.properties | grep response_namespace
response_namespace = http://obs.myhwclouds.com/doc/2006-06-30

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 34


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

OMS01:~ # cat /opt/obs/obsconf/jets3t.properties | grep response_namespace


response_namespace = http://obs.myhwclouds.com/doc/2006-06-30
OMS01:~ # cat /opt/obs/obsconf/poejets3t.properties | grep response_namespace
response_namespace = http://obs.myhwclouds.com/doc/2006-06-30
OMS01:~ # cat /opt/obs/obsconf/upf/upfjets3t.properties | grep
response_namespace
response_namespace = http://obs.myhwclouds.com/doc/2006-06-30
OMS01:~ # cat /opt/obs/obsconf/AmazonS3.xsd | grep targetNamespace
targetNamespace="http://obs.myhwclouds.com/doc/2006-06-30"

The value of response_namespace has been changed to the value that is set using a CLI
command.
3. Run the following commands in sequence to restart the OSC process:
OMS01:~ # sh /opt/obs/service/osc/bin/osc.sh stop
OMS01:~ # sh /opt/obs/service/osc/bin/osc.sh start

4. Run the following commands in sequence to restart the OIS process:


OMS01:~ # sh /opt/obs/service/ois/bin/ois.sh stop
OMS01:~ # sh /opt/obs/service/ois/bin/ois.sh start

5. Log in to the specified access nodes using SSH according to the batch plan, and restart
the OSC and OIS process by repeating steps 1 to 3.

3.8 change bssip


Function
The change bssip command is used to change bss event notify ip and port.

Format
change bssip <ip> <port>

Parameters
Parameter Description Value

ip BSS EventNotify IP address IPV4 format

port BSS EventNotify Port legal Port number(1-65535)


number

Usage Guidelines
The command is a valid character string that contains IPV4:
change bssip 10.129.11.1 8090

Example
cli@OMS01:~> change bssip 10.129.11.1 8090
SUCCESS:change bss ip info success!

System Response
After the modification, you can check that the value of the service in /opt/obs/obsconf/
upf_adapter.properties has been changed.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 35


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

# grep bss_server /opt/obs/obsconf/upf_adapter.properties


bss_server_host=10.129.11.1:8090

3.9 change tomcatAccessWhitelist


Function
the change tomcatAccessWhitelist command is used to set up ip addresses for accessing
tomcat service.

Format
change tomcatAccessWhitelist <ip>

Parameters
Parameters Description Value

ip IP address that can access all: all IP addresses


the Tomcat service IPV4 format:
Default value: all 127.0.0.1
127.0.0.1,127.0.0.2
127.0.0.*

Usage Guidelines
l Exercise caution when running this command because this highly risky operation may
result in access failures of some IP addresses.
l The command must contain valid IP addresses, IP address segments, and all (all IP
addresses). Use commas (,) to separate multiple IP addresses. Use asterisks (*) to
replace IP address segments, for example:
change tomcatAccessWhitelist all
change tomcatAccessWhitelist 127.0.0.1
change tomcatAccessWhitelist 127.0.0.1,127.0.0.2
change tomcatAccessWhitelist 127.0.0.*

Example
cli@OMS02:~> change tomcatAccessWhitelist 127.0.0.1
Congratulations, config ip whitelist successfully.

System Response
When ip address is set, please check the value of
org.apache.catalina.valves.RemoteAddrValve in /opt/omm/oms/tomcat/conf/server.xml.
# grep "org.apache.catalina.valves.RemoteAddrValve" /opt/omm/oms/tomcat/conf/
server.xml |grep allow
<Valve className="org.apache.catalina.valves.RemoteAddrValve" allow="127.0.0.1"/>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 36


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

After the value of an IP address is set to all, the /opt/omm/oms/tomcat/conf/server.xml


configuration file does not contain the org.apache.catalina.valves.RemoteAddrValve field.

3.10 change jettytime


Function
The change jettytime command is used to configure the maxIdleTime value in the jetty
configuration file of UDS. After this command is executed. You must log in to OSC nodes of
the UDS system in sequence and manually restart the OSC process.

Format
change jettytime <noticeinfo>

Parameters
Parameter Description Value Unit

jettytime Maximum idle time of a Positive integer Millisecond


thread
Default value: 30000

Usage Guidelines
l The command must be a valid character string with no spaces or tabs, for example,
change jettytime 30000.
l Log in to the OSC node as user opadmin (default password: Uds6200!), run the su -
root command to switch to user root, and run the following command to stop the OSC
process:
To stop the OSC process: sh /opt/obs/service/osc/bin/osc.sh OSC processes stop
To start the OSC process: sh /opt/obs/service/osc/bin/osc.sh OSC processes start

Examples
cli@OMS01: > change jettytime 30000
SUCCESS:change jetty time info success!

Stopping OSC Process Examples


OMS01:/home/permitdir # sh /opt/obs/service/osc/bin/osc.sh stop
Result:success
Stopping Jetty: OK

Starting OSC Process Examples


OMS01:/home/permitdir # sh /opt/obs/service/osc/bin/osc.sh start
Result:success

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 37


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

System Response
After the modification, run the /opt/obs/service/osc/etc/jetty.xml command to check that the
value of field maxIdleTime in the configuration file has been changed to the one in the
command.
# grep maxIdleTime /opt/obs/service/osc/etc/jetty.xml
<Set name="maxIdleTime">30000</Set>

3.11 change billingprefix


Function
The change billingprefix command is used to configure the prefix of a charging data record
(CDR) in UDS.

Format
change billingprefix <noticeinfo>

Parameters
Parameter Description Value

billingprefix Prefix character string of a The value is a string


CDR containing 1 to 31
Default value: HWS characters.

Usage Guidelines

NOTICE
When the CDR format is changed, you must delete existing temporary CDRs and restart
the OSC process of A-Nodes in UDS. Run this command after you have changed all
parameters. Perform the step manually as follows:
Log in each A-Node (OMS and OSC nodes) using the CLI, switch to user root. For details,
see the UDS Administrator Guide. After the switch is successful, run the following command:
OMS01:~ # sh /opt/obs/scripts/osc/changeBillFormat.sh Result:success
Result:success Stopping Jetty: OK Result:success Result:success
Stopping Jetty: OK
Result:success
Result:success

If information similar to the preceding command output is displayed, the CDR format has
been successfully changed. Run this command on each A-Node in sequence. Do not restart all
nodes at the same time to ensure service continuity.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 38


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

l The command must be a valid character string, the system supports letters and digits, for
example, change billingprefix OTC.

Examples
cli@OMS01: > change billingprefix OTC
SUCCESS:change billing prefix info success!

System Response
After the modification, run the/opt/obs/obsconf/obs_sod.properties command to check that
the value of field BILLINGPrefix in the configuration file has been changed to the one in the
command.
# grep BILLINGPrefix /opt/obs/obsconf/obs_sod.properties
BILLINGPrefix= OTC

3.12 change billfilter


Function
The change billfilter command is used to change the prefix field of the domainname whose
CDR is not generated in UDS.

Format
change billfilter <noticeinfo>

Parameters
Parameter Description Value

noticeinfo A character string of a domainname:prefix1,prefix2


specified format ,...,prefix (value range:
Default value: Unconfigured 11-1023)

Usage Guidelines
l The noticeinfo contains valid character strings without spaces or the Table key.
l The noticeinfo must start with domainname: and each domainname is separated by
commas (,).
l Exercise caution when you run this command because contents in noticeinfo will replace
the original configuration. for example, change billfilter domainname:shadow_,op_

Examples
cli@OMS01: > change billfilter domainname:shadow_,op_
SUCCESS:change billfilter success!

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 39


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

System Response
After the prefix field is changed, check the /opt/obs/obsconf/obs_sod.properties
configuration file. It can be seen from the following output that the value of
domain_name_nobilling is changed to the value in noticeinfo.
# grep domain_name_nobilling /opt/obs/obsconf/obs_sod.properties
domain_name_nobilling=shadow_,op_

3.13 change regioncopy


Function
The change regioncopy command is used to configure a switch for the replication within a
region in UDS.

Format
change regioncopy <noticeinfo>

Parameters
Parameter Description Value

regioncopy A switch for the replication true|false


within a region
Default value: false

Usage Guidelines
l The command must be a valid character string with no spaces or tabs, for example,
change regioncopy true.

Examples
cli@OMS01: > change regioncopy true
SUCCESS:change region copy info success!

System Response
After the modification, run the/opt/obs/obsconf/obs_sod.properties command to check that
the value of field REGIONCopy in the configuration file has been changed to the one in the
command.
# grep REGIONCopy /opt/obs/obsconf/obs_sod.properties
REGIONCopy = true

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 40


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.14 change bssdomain


Function
The change bssdomain command is used to configure the format of a CDR bitmap in UDS.

Format
change bssdomain <noticeinfo>

Parameters
Parameter Description Value

bssdomain Format of a CDR bitmap 24 Characters


Default value:
000000000000000000000000

Usage Guidelines

NOTICE
When the CDR format bit is changed from 0 to 1 in the following table, the Deutsche
Telekom CDR format is enabled. When the local time bit is changed from 0 to 1 in the
following table, the LocalBeginTime and LocalEndTime in the Deutsche Telekom CDR
format are the local system time. If the value of warm, cold bss mode changes from 0 to 1,
warm, cold bss mode is enabled.

l The command must be a valid character string with no spaces or tabs, for example,
change bssdomain 000000000000000000000000.

Table 3-1
Parameter Value (0) Value (1)

RECORD_TYPE \ \

TimeStamp \ \

UserID \ \

RegionID \ \

AZID \ \

CloudServiceType \ \

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 41


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameter Value (0) Value (1)

CloudResourceType \ \

ResourceSpecCode \ \

ResourceID \ \

XID \ \

BeginTime \ \

EndTime \ \

AccumulateFactorName \ \

AccumulateFactorValue \ \

remote ip \ \

status code \ \

request id \ \

bucketname \ \

object size \ \

op type \ \

Charging format(Deutsche If the value is 0, use If the value is 1, use


Telekom) default charging format. charging foramt of
Deutsche Telekom

Using local time(Deutsche If the value is 0, do not use If the value is 1, use local
Telekom) local system time. system time.

warm, cold bss mode If the value is 0, use the If the vale is 1, use warm,
default CDR format. cold bss mode.

Reserved for new \ \


parameters

Examples
cli@OMS01: > change bssdomain 000000000000000000000000
SUCCESS:change bss domain success!
The follow example just will modify the first two bit, the number 9 means default
will keep the old value.
cli@OMS01: > change bssdomain 119999999999999999999999
SUCCESS:change bss domain success!
# grep BSSParams /opt/obs/obsconf/obs_sod.properties
BSSParams = 110000000000000000000000

System Response
After the modification, run the/opt/obs/obsconf/obs_sod.properties command to check that
the value of field BSSParams in the configuration file has been changed to the one in the
command.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 42


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

# grep BSSParams /opt/obs/obsconf/obs_sod.properties


BSSParams = 110000000000000000000000

3.15 change oschttpenable


Function
The change oschttpenable command is used to set whether the OSC process supports the
HTTP protocol. true indicates that the OSC process supports the HTTP protocol. false
indicates that the OSC process does not support the HTTP protocol.

Format
change oschttpenable <noticeinfo>

Parameters
Parameter Description Value

oschttpenable Indicates whether the OSC true|false


process supports the HTTP
protocol.
Default value: true

Usage Guidelines
l Exercise caution when disable the HTTP protocol because this highly risky operation
may result in service denial.
l The HTTP protocol has security risks and is not recommended.
l The command must be a valid character string with no spaces or tabs, for example:
change oschttpenable true

Examples
cli@OMS01: > change oschttpenable true
Please check again, open http is High risk operation, are you sure:[yes|no]:yes
your choice is yes, will change it!
SUCCESS:change osc http enable status success!

System Response
If the value of oschttpenable is set to true, parameters HTTPBEGIN and HTTPEND in
configuration file /opt/obs/service/osc/etc/jetty.xml are modified as follows:
# grep HTTPBEGIN /opt/obs/service/osc/etc/jetty.xml
<!--HTTPBEGIN
<!--HTTPBEGIN
# grep HTTPEND /opt/obs/service/osc/etc/jetty.xml
HTTPEND-->
HTTPEND-->

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 43


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

If the value of oschttpenable is set to false, parameters HTTPBEGIN and HTTPEND in


configuration file /opt/obs/service/osc/etc/jetty.xml are modified as follows:
# grep HTTPBEGIN /opt/obs/service/osc/etc/jetty.xml
<!--HTTPBEGIN-->
<!--HTTPBEGIN-->
# grep HTTPEND /opt/obs/service/osc/etc/jetty.xml
<!--HTTPEND-->
<!--HTTPEND-->

3.16 change poehttpenable


Function
The change poehttpenable command is used to set whether the POE process supports the
HTTP protocol. true indicates that the POE process supports the HTTP protocol. false
indicates that the POE process does not support the HTTP protocol.

Format
change poehttpenable <noticeinfo>

Parameters
Parameter Description Value

poehttpenable Indicates whether the POE true|false


process supports the HTTP
protocol.
Default value: true

Usage Guidelines
l Exercise caution when disable the HTTP protocol because this highly risky operation
may result in service denial.
l The HTTP protocol has security risks and is not recommended.
l The command must be a valid character string with no spaces or tabs, for example:
change poehttpenable true

Examples
cli@OMS01: > change poehttpenable true
Please check again, open http is High risk operation, are you sure:[yes|no]:yes
your choice is yes, will change it!
SUCCESS:change osc http enable status success!

System Response
If the value of poehttpenable is set to true, parameters HTTPBEGIN and HTTPEND in
configuration file /opt/obs/service/poe/etc/jetty.xml are modified as follows:
# grep HTTPBEGIN /opt/obs/service/poe/etc/jetty.xml
<!--HTTPBEGIN

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 44


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

# grep HTTPEND /opt/obs/service/poe/etc/jetty.xml


HTTPEND-->

If the value of poehttpenable is set to false, parameters HTTPBEGIN and HTTPEND in


configuration file /opt/obs/service/poe/etc/jetty.xml are modified as follows:
# grep HTTPBEGIN /opt/obs/service/poe/etc/jetty.xml
<!--HTTPBEGIN-->
# grep HTTPEND /opt/obs/service/poe/etc/jetty.xml
<!--HTTPEND-->

3.17 change iptablesrule


Function
The change iptablesrule command is used to configure the source IP aaddress, or source IP
address and netmask corresponding to the management IP address including the oms
management IP address, oms management floating IP address and osc management IP
address. The modified iptables rule takes effect when corresponding scripts are used based on
the node type.

Format
change iptablesrule <iplist>

Parameters
Parameter Description Value

iplist The parameter is added into the iptables Possible values are:
rule as the source IP address or source l Character string
IP address and netmask. consisting of valid IP
addresses or IP address
segments: The iptables
rule specifies that the
management IP address
is restricted by the
source IP address or
source IP address
segment.
l Empty character string
("") or one or more
spaces (" "): iptables is
set as a default rule. The
iptables rule specifies
that the management IP
address is not restricted
by the source IP address
or source IP address
segment.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 45


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
l Exercise caution when running this command because this highly risky operation may
result in access failures of some IP addresses.
l The iplist is a string with several valid IP address or IP address and netmask. The
netmask value ranges from 1 to 32, and the string is within 1024 bytes.
l Using a comma (,) between every two IP addresses, or IP address and netmasks. the
string must be enclosed in quotation marks (""). For example,
change iptablesrule "10.28.14.80,10.28.0.0/16"

Examples
cli@OMS01:~> change iptablesrule "10.28.0.0/16"
SUCCESS:modify iptables rule success!

System Response
After the modification, you can run the iptables-save command to view the iptables rule that
have taken effect. The management IP address corresponding rule has added the entered
parameter value as the source IP address or source IP address and netmask.
OMS01:~ # iptables-save
-A INPUT -s 10.28.0.0/16 -d 10.28.129.1/32 -p udp -m udp --dport 161 -j ACCEPT
-A INPUT -s 10.28.0.0/16 -d 10.28.129.1/32 -p udp -m udp --dport 10161 -j ACCEPT

3.18 change mgmtdatabackup


Function
The change mgmtdatabackup command is used to switch on or off the feature of
management data backup. The purpose is update the current parameters list to the new
legitimacy input in the corresponding database table.

Format
change mgmtdatabackup <switchstatus> [protocol] [ipaddress] [port] [serverdir]
[username]

Parameters
Parameter Description Value

switchstatus The switch of the management data on/ON: switch on the


backup feature. management data backup
feature.
off/OFF: switch off the
management data backup
feature.

protocol The protocol for uploading management ftp/FTP:ftp protocol


data. ftps/FTPS:ftps protocol
sftp/SFTP:sftp protocol

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 46


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameter Description Value

ipaddress The IP address of the backup server. valid IP address

port The port number of the backup server. integer, value ranges from 1
to 65535.

serverdir The designated directory of the backup A string with '/' at the
server for storing management data. beginning, and within 128
bytes.

username The user name for uploading A string within 64 bytes.


management data.

password The password for uploading A string with in 64 bytes.


management data (this parameter is an
interactive parameter).

Usage Guidelines
l Do not input other parameters when the value of switchstatus is off/OFF.
l This operation involves sensitive information dump, please keep it properly.
l ftp protocol is an unsafe protocol, we recommend that you use ftps protocol.
l serverdir is a string with '/' at the beginning, and within 128 bytes. It stored in the
database in encrypted form. The string must be enclosed in quotation marks ("") or ('')
when including special characters.
l username is a string within 64 bytes. It stored in the database in encrypted form. The
string must be enclosed in quotation marks ("") or ('') when including special characters.
l password is a string within 64 bytes. It stored in the database in encrypted form. It does
not support character '`' ,and character '\' as the escape character priority. The input of
password adopt the mode of interaction, and ther user must inpt twice in case of wrong
password input.
l The value of switchstatus must be on or off. For example,
change mgmtdatabackup off
OR
change mgmtdatabackup on sftp 10.28.0.1 8080 /test admin

Examples
cli@OMS01:/root> change mgmtdatabackup off
SUCCESS:change management data backup configuration parameter successed!
cli@OMS01:/root> change mgmtdatabackup on ftp 10.28.238.90 22 /wxm wxm
CAUTION: This operation involves sensitive information dump, please keep it
properly.
Warning: ftp is an unsafe protocol, we recommend that you use ftps protocol.
Do you want to continue?(yes/no):y
Enter Password:******
Enter Password again:******
SUCCESS:change manage data backup configuration parameter successed!

System Response
By querying the database, you can view the parameter values configured for the management
data backup function.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 47


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from


uds_1.\"Tbl_MGMTDATABACKUP_Info_Set\";"
Password for user gaussdba:
ID | VALUE
----------+-------
MgmtData | off
(1 row)
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from
uds_1.\"Tbl_MGMTDATABACKUP_Info_Set\";"
Password for user gaussdba:
ID
|
VALUE

----------
+---------------------------------------------------------------------------------
-------------------------------------------------------
--------------------------------
MgmtData | on ftp 10.28.238.90 22 @2@108635352,165320461@4DG/whHG
+8v9nKknopuy3g== @2@421552691,399508949@S/U9ZUeUvkpMiQ/l++Cncg== @2@17488883,390
000939@fiHzbKyUPLQZNUIPC0F2Tg==
(1 row)

lines 1-5/5 (END)

3.19 change accesslogopen


Function
The change accesslogopen command is used to open or close the s3 access log output service.

Format
change accesslogopen <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Service status. true: The service is true|false


opened. false: The service is closed.
Default value: false

Usage Guidelines
The command is a valid character string that contains true or false:

change accesslogopen true

or

change accesslogopen false

Examples
cli@OMS01: > change accesslogopen true
SUCCESS:change AccessLogOpen success!

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 48


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

System Response
After the modification, you can check that the value of the service in /opt/obs/obsconf/
obs_sod.properties has been changed to the one in the command。
# grep access_log_open /opt/obs/obsconf/obs_sod.properties
access_log_open = true

3.20 change OSCDisableTlsvOnePointOne


Function
The change OSCDisableTlsvOnePointOne command is used to configure whether need
disable the osc "TLSv1.1" protocol.

Format
change OSCDisableTlsvOnePointOne <noticeinfo>

Parameters
Parameter Description Value

noticeinfo True means disable TLSv1.1 protocol; true|false


False means enable TLSv1.1 protocol;
Default value: false

Usage Guidelines
l The value must be true or false, For example:
change OSCDisableTlsvOnePointOne true

Examples
cli@OMS01: > change OSCDisableTlsvOnePointOne true
SUCCESS:change OSCDisableTlsvOnePointOne success!

Note: After change this configuration, you need restart osc service let configuration works.
On all of the extended or reinstalled osc nodes also need restart osc service.
sh /opt/obs/service/osc/bin/osc.sh stop
sh /opt/obs/service/osc/bin/osc.sh start

System Response
According above's modification, you will see TLSv1.1 item is already add to /opt/obs/
service/osc/etc/jetty.xml.
OMS01:/opt/obs/service/osc/etc # grep -A 5 "ExcludeProtocols" jetty.xml
<Set name="ExcludeProtocols">
<Array type="java.lang.String">
<Item>SSLv2</Item>
<Item>SSLv3</Item>
<Item>TLSv1.1</Item>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 49


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.21 change garbagebuckettime


Function
The change garbagebuckettime command is used to set the time for data in the Recycle Bin
to be permanently deleted.

Format
change garbagebuckettime <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Time for data in the Recycle Bin to be Long variables


permanently deleted.
Default value: 172800000
Unit: ms

Usage Guidelines
l The command is a string of long variables, such as:
change garbagebuckettime true

Examples
cli@OMS01: > change garbagebuckettime 172800000
SUCCESS:change garbagebuckettime success!

You do not need to restart the OIS service after the modification. The modification takes
effect only when the next Recycle Bin scanning period starts.

System Response
After the modification, you can run the /opt/obs/obsconf/obs_sod.properties command to
check that the value of parameter garbage_object_delete_time in the configuration file has
been changed to the one in the command.
OMS01:/opt/obs/service/osc/etc # grep "garbage_object_delete_time" /opt/obs/
obsconf/obs_sod.properties
garbage_object_delete_time=172800000

3.22 change websiteloc


Function
The change websiteloc command is used to configure the website URL in UDS.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 50


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change websiteloc <noticeinfo>

Parameters
Parameter Description Value

noticeinfo The URL which used to send website Valid URL


request to UDS.
Default value: Add "-website" field to
region URL. For example, if the region
URL is: http://region.huawei.com, the
default URL of website is http://region-
website.huawei.com.

Usage Guidelines
l The parameter of command must begin with http or https, such as:
change websiteloc http://uds.website.huawei.com

Examples
cli@OMS01: > change websiteloc http://uds.website.huawei.com
SUCCESS:change WebsiteLoc success!

System Response
After the modification, you can run the /opt/obs/obsconf/obs_sod.properties command to
check that the value of parameter website_home_location in the configuration file has been
changed to the one in the command.
# grep website_home_location /opt/obs/obsconf/obs_sod.propertie
website_home_location = http://uds.website.huawei.com

3.23 start import license


Function
Imports a license file.

Format
start import license <noticeinfo>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 51


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameters
Parameter Description Value

noticeinfo License file name, for Character string variables


example,
LICORTF365621-2AC1F9
0BA3_UDS_HJH.dat.

Usage Guidelines
l The command is a valid character string, for example, start import license
LICORTF365621-2AC1F90BA3_UDS_HJH.dat.

Example
This operation can be performed only by user root shown as follows:
OMS02:/ # start import license LICORTF365621-2AC1F90BA3_UDS_HJH.dat import
license success!

NOTE

1. The size of a license file ranges from 0 MB to 5 MB.


2. A license file name must be in .dat format.
3. Importing a license file can be performed as user root only.
4. Before importing a license file, save the original license file to the specified directory/
home/permitdir.
5. After a license file is imported successfully, the user needs to manually delete the license
source file under the /home/permitdir directory.

System Response
1. If a license file is imported successfully, an import success message is displayed, for
example, import license success!
2. If a license file fails to be imported, an import failure message is displayed, for example,
importLicenseFile is lower than 0KB!

3.24 start active license


Function
Activates a license file.

Format
start active license

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 52


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameters
None

Usage Guidelines
l The command is a valid character string, for example, start active license.

Example
OMS02:/ # start active license active license success!

1.Importing a license file can be performed as user root only.

System Response
1. If a license file is activated successfully, an activation success message is displayed, for
example, active license success!

2. If a license file fails to be activated, an activation failure message is displayed, for example,
check license error!

3.25 add route


Function
The add route command is used to add a router.

Format
add route net <network> netmask <netmask> gw <gateway>

Parameters
Parameter Description Value

network Router destination address Valid IP address

netmask Specified net mask of an Valid sub-net mask


added router

gateway Gateway Valid IP address

Usage Guidelines
The command is a valid character string, for example,

add route net 172.29.39.0 netmask 255.255.255.0 gw 192.168.31.254

Example
Use a CLI account to perform operations, for example:

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 53


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

cli@OMS01:~> add route net 172.29.39.0 netmask 255.255.255.0 gw 192.168.31.254


SUCCESS:add route success!

Note:

1. This command must be executed on the primary node.

2. The specified gateway must be reachable.

3. To add a router, the rules to use the system router command must be complied with.
Otherwise, the router fails to be added.

System Response
Output Information Instruction

SUCCESS:add route success! A router is added successfully

ERROR:input error, invalid ipv4 address Invalid IP

ERROR:input error, invalid netmask Invalid sub-net mask

ERROR:input error, invalid gateway Invalid gateway

ERROR:netmask doesn't match route Sub-net mask doesn't match route address
address

ERROR:No such process The specified gateway is not reachable

ERROR:bogus netmask [netmask] Bogus sub-net mask

ERROR:File exists The router is already existing

ERROR:exceed the maximum limit number The total number of routers has been
of routing add (20) reached the maximum limit number of
routing add (20)

ERROR:add route failed! Add failed as a result of abnormal CMS


services

3.26 delete route


Function
The delete route command is used to delete a router.

Format
delete route net <network> netmask <netmask> gw <gateway>

Parameters
Parameter Description Value

network Router destination address Valid IP address

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 54


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameter Description Value

netmask Specified net mask of an Valid sub-net mask


added router

gateway Gateway Valid IP address

Usage Guidelines
The command is a valid character string, for example,

delete route net 172.29.39.0 netmask 255.255.255.0 gw 192.168.31.254

Example
Use a CLI account to perform operations, for example:
cli@OMS01:~> delete route net 172.29.39.0 netmask 255.255.255.0 gw 192.168.31.254
SUCCESS:delete route success!

Note:

1. This command must be executed on the primary node.

2. When a deleted router does not exist, deleting the router running this command will be
failed.

System Response
Output Information Instruction

SUCCESS:delete route success! A router is added successfully

ERROR:input error, invalid ipv4 address Invalid IP

ERROR:input error, invalid netmask Invalid sub-net mask

ERROR:input error, invalid gateway Invalid gateway

ERROR:No such process The router is not existing

ERROR:delete route failed! Delete failed as a result of abnormal CMS


services

3.27 change alarmInfoSwitch


Function
The change alarmInfoSwitch command is used to switch on or off the feature of TRAP
alarm information.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 55


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change alarmInfoSwitch <noticeinfo>

Parameters
Parameter Description Value

noticeinfo The switch of the TRAP alarm on: switch on the TRAP
information feature. alarm information feature.
off: switch off the TRAP
alarm information feature.

Usage Guidelines
l The value of noticeinfo must be on or off. For example,
change alarmInfoSwitch on
OR
change alarmInfoSwitch off

Examples
cli@OMS02:~> change alarmInfoSwitch on
SUCCESS:change alarminfo switch configuration parameter successed!
cli@OMS02:~> change alarmInfoSwitch off
SUCCESS:change alarminfo switch configuration parameter successed!

System Response
By querying the database, you can view the parameter values configured for the TRAP alarm
information function.
OMS02:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_AlarmInfoSwitch
\";"
Password for user gaussdba:
ID | VALUE
------------+-------
SwitchInfo | on
(1 row)
OMS02:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_AlarmInfoSwitch
\";"
Password for user gaussdba:
ID | VALUE
------------+-------
SwitchInfo | off
(1 row)

3.28 change reptaskscaninterval


Function
The change reptaskscaninterval command is used to set the interval to replicate the fast scan
tasks between AZs. This command applies to scenarios with multiple AZs in the active AZ.

Format
change reptaskscaninterval <noticeinfo>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 56


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameters
Parameter Description Value

noticeinfo the interval to replicate the fast scan 60-1440.


tasks between AZs Unit:Minutes
Default:720

Usage Guidelines
l The value of noticeinfo must be between 60 and 1440. For example,
change reptaskscaninterval 60

Examples
cli@OMS02:~> change reptaskscaninterval 60
SUCCESS:change RepTaskScanInterval success!

System Response
By querying the config file, you can view the parameter values configured.
OMS02:~ # vi /opt/obs/obsconf/obs_sod.properties

#fast visitor period: MINUTES, default: 12 hours


fastvisitor_period = 60

3.29 change forbidcbc


Function
The change forbidcbc command is used to change the status of the CBC mode of SSH.

Format
change forbidcbc <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Status of the CBC mode of SSH. on: The CBC mode of SSH
is forbidden and the system
cannot be connected in
CBC mode.
off: The CBC mode of SSH
is not forbidden and the
system can be connected in
CBC mode.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 57


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
l Note the following when changing the status of the CBC mode:
By default, the CBC mode of SSH is supported by the UDS. Considering security, users
are advised to forbid the CBC mode. After the CBC mode is forbidden, the UDS cannot
be remotely connected using XSHELL earlier than 5.0 or XFTP earlier than 5.0.
Therefore, before forbidding the CBC mode, ensure that the version of XSHELL used to
log in to the UDS, the version of the tool used to manually obtain the charging data
records (CDRs), and the version of the tool used by the billing center (BC) to obtain
CDRs meet version requirements. In this manner, the UDS can still be remotely
connected after the CBC mode is forbidden.
l The value of noticeinfo can only be on or off. The example is as follows:
change forbidcbc on
or
change forbidcbc off

Examples
cli@OMS01:~> change forbidcbc on
SUCCESS:change forbidcbc status on successed!
cli@OMS01:~> change forbidcbc off
SUCCESS:change forbidcbc status off successed!

System Response
Go to the database to view the current parameter values.
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_Forbidcbc_Info
\";"
Password for user gaussdba:
ID | VALUE
------------+-------
forbidcbcFlag | on
(1 row)
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from uds_1.\"Tbl_Forbidcbc_Info
\";"
Password for user gaussdba:
ID | VALUE
------------+-------
forbidcbcFlag | off
(1 row)

3.30 change smninfo


Function
The change smninfo command is used enable or disable the SMN, or change the SMN IP
address.

Format
change smninfo <switch> <address>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 58


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameters
参数 参数说明 取值

switch Switch of the SMN service. enable: enables the SMN


service and inherits the
SMN IP address configured
last time.
disable: disables the SMN
service.

address(optional) network address of the SMN support IP address and


service. domain name

Usage Guidelines
l The command must be a valid character string that does not contain spaces or the Table
sign.
l The value of switch address must be enable, disable, or enable address. If the value is
enable address, it will enable the SMN service and change the SMN network address to
address.
l Before changing the SMN IP address, ensure that the SMN service and the network are
normal. If the configuration is incorrect, the Communication Between the UDS and
SMN Is Abnormal alarm (ID: 60179873918) is reported.

Examples
cli@OMS01:~> change smninfo enable
Result: Success!
cli@OMS01:~> change smninfo disable
Result: Success!
cli@OMS01:~> change smninfo enable https://172.16.0.4:443
Result: Success!

System Response
View /opt/obs/obsconf/obs_sod.properties. If the value of noticeinfo is set to true, the value
of smn_connection must be true. If the value of noticeinfo is set to false, the value of
smn_connection must be false. Besides, check whether the value of smn_address is correct.
# grep smn_connection /opt/obs/obsconf/obs_sod.properties
smn_connection=true
# grep smn_address /opt/obs/obsconf/obs_sod.properties
smn_address=https://172.16.0.4:443

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 59


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.31 change customizedomainenable


Function
The change customizedomainenable command is used to turn on or off the switch. If the
switch is turned on, the UDS processes the customized domain name as the bucket name. If
the switch is turned off, the UDS queries the mapping between the customized domain name
and bucket.

Format
change customizedomainenable <noticeinfo>

Parameters
参数 参数说明 取值

noticeinfo Turns on or off the switch. true: turns on the switch.


false: turns off the switch.
The default value is false.

Usage Guidelines
l The value of noticeinfo must be true or false.

Examples
cli@OMS01:~> change customizedomainenable false
SUCCESS:change CustomizeDomainEnable success!
cli@OMS01:~> change customizedomainenable true
SUCCESS:change CustomizeDomainEnable success!
cli@OMS01:~>

System Response
View /opt/obs/obsconf/obs_sod.properties. If the value of noticeinfo is set to true, the value
of customizeDomainEnable must be true. If the value of noticeinfo is set to false, the value
of customizeDomainEnable must be false.
# cat /opt/obs/obsconf/obs_sod.properties|grep customizeDomainEnable
customizeDomainEnable = false
#

3.32 change udscryptotype


Function
The change udscryptotype command is used to change the encryption/decryption algorithm
used by the UDS. Currently, the UDS supports only the encryption algorithm whose type is 1,
that is, AES-128-CBC.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 60


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change udscryptotype <type>

Description
Parameter Description Value

type Type of the encryption 1: AES-128-CBC


algorithm used by the UDS

Usage Guidelines
l The value of type must be a valid character string that cannot contain spaces or tab stops.
l The UDS defines only one manageable encryption/decryption algorithm. Its type must
be 1.

Examples
cli@OMS01:~> change udscryptotype 1
SUCCESS: change UdsCryptoType success!

System Response
Run /opt/obs/obsconf/crypto.properties. If the value of crypto_type is 1, the encryption/
decryption algorithm is successfully changed.
OMS01# grep crypto_type /opt/obs/obsconf/crypto.properties
crypto_type=1

3.33 change obssvcpassword


Function
The change obssvcpassword command is used to change the password of account
op_svc_obs who is used to authenticate services inside the public cloud.

Format
change obssvcpassword

Parameters
Interactive Description Value
Parameter

password Password of account op_svc_obs A character string containing 1 to 32


who is used to authenticate characters
services inside the public cloud

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 61


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
The value of password is a character string containing 1 to 32 characters. It exists in
databases in ciphertext mode. A password must be entered twice to verity that it was entered
correctly.

Examples
cli@OMS01:~> change obssvcpassword
Do you want to reset password?(yes/no):yes
Enter Password:******
Enter Password again:******
SUCCESS: change obssvcpassword success!

System Response
View /opt/obs/obsconf/ upf_adapter.properties. If the value of obs_svc_password is
changed, the password is successfully changed.
OMS01# grep obs_svc_password /opt/obs/obsconf/upf_adapter.properties
obs_svc_password=******

3.34 change bucketblacklist


Function
Configures a bucket blacklist. The buckets in the blacklist cannot be created.

Format
change bucketblacklist <action> <bucketName>

Parameters
Parameter Description Value

action Operation type. add means adding a add|delete


bucket to a blacklist; delete means
deleting a bucket from a blacklist.

bucketName Name of a bucket to be blacklisted. The bucket naming rules


Configure one bucket at a time. Each must be met. For details, see
blacklist contains a maximum of 100 section "Restrictions" in
bucket names, and the length of all chapter "Using
bucket names plus separators between Buckets"inthe OceanStor
the bucket names cannot be longer than UDS V1R2C01LHWS02U1
1023 characters. Bucket separators are Object Storage Service
automatically added by the system. Developer Guide.
Number of separators = Number of
buckets in a blacklist – 1

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 62


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Usage Guidelines
l When the value of action is set to add, you can blacklist one bucket. Only one bucket
name can be added to a blacklist at a time. If a bucket name has been added to a
blacklist, you cannot add it again. That is, a blacklist does not contain repetitive bucket
names.
l When the value of action is set to delete, you can delete one bucket name from a
blacklist. Only one bucket name can be deleted from a blacklist at a time. If the bucket
name is not in the blacklist, this operation is invalid.
l The value of bucketName must meet bucket naming rules. Otherwise, an "invalid
bucketname" error will be returned.

Examples
Example1:add a bucket name to a blacklist.
cli@OMS01:~> change bucketblacklist add bucket.testname
SUCCESS:update bucket_black_list success! [add,bucket.testname]

Example 2: delete a bucket name from a blacklist.


cli@OMS01:~> change bucketblacklist delete bucket.testname
SUCCESS:update bucket_black_list success! [delete,bucket.testname]

System Response
Output Information Instruction

SUCCESS:update bucket_black_list The bucket name is successfully added to


success! [add,bucket.testname] the blacklist.

[bucket.testname] already blacklisted. The bucket name exists in the blacklist.

SUCCESS:update bucket_black_list The bucket name is successfully deleted


success! [delete,bucket.testname] from the blacklist.

[abc] not exist in blacklist. The bucket name does not exist in the
blacklist.

ERROR:invalid action[ad]! add/delete are The operation type is invalid.


allowed.

ERROR:invalid bucketname! The bucket name is invalid.

ERROR:blacklist beyond The number of the bucket name to be added


max_bucket_num_limit[100]. to the blacklist exceeds the upper limit.

ERROR:blacklist beyond The number of bucket name characters +


max_character_num_limit[1023]. separators (number of separators = number
of buckets – 1) exceeds the upper limit.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 63


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.35 change storageclassenable


Function
Enables the storage tiering function.

Format
change storageclassenable true

Parameters
Parameter Description Value

storageclassenable Storage tiering true: to enable the storage


tiering function

NOTICE
Enabling the storing tiering function cannot be undone.

Usage Guidelines
l The command must be a valid character string with no spaces or tabs, for example:
change storageclassenable true

Example
cli@OMS01:~> change storageclassenable true
SUCCESS:change storageclassenable success!

System Response
After the modification, you can view /opt/obs/obsconf/obs_sod.properties to check that the
value of parameter storage_class_enable in the configuration file has been changed to the
one in the command.
# grep storage_class_enable /opt/obs/obsconf/
obs_sod.propertiesstorage_class_enable=true

3.36 change coexiststatus


Function
Changes the service forwarding status of the system.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 64


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change coexiststatus <status>

Parameters
Parameter Description Value

status Sets the status of service 0|1|2


forwarding. 0 indicates that
service forwarding is
disabled; 1 indicates that a
configured IP address is used
to forward services; 2
indicates that a region
domain name is used to
forward services.

Usage Guidelines
l Before setting the status of service forwarding to 1, ensure that the target cluster address
has been configured using the change newclusterendpoint command.
l Before setting the status of service forwarding to 2, ensure that the region domain name
in the DNS has pointed to the target cluster address and the cache has been updated.
l Command change coexiststatus is used mainly during the coexistence configuration of
coexist features. Exercise caution when running the change coexiststatus command,
because it will interrupt service processing. When this command is executed, the
following information is displayed:
cli@OMS02:~> change coexiststatus 1 This operation is very dangerous,
especially when the value from 2 to 0, please ensure that the new cluster
does not complete the consistency of the scan action, the value is not
allowed to change after the completion of this action, Do you want to
continue?(YES|yes|NO|no)

If you want to continue, enter YES or yes. Otherwise, enter NO or no.

Example
cli@OMS02:~> change coexiststatus 1 This operation is very dangerous,
especially when the value from 2 to 0, please ensure that the new cluster does
not complete the consistency of the scan action, the value is not allowed to
change after the completion of this action, Do you want to continue?(YES|yes|NO|
no) yes SUCCESS:change CoExistStatus success!

System Response
Output Information Instruction

SUCCESS:change NewClusterEndPoint The target cluster address is successfully


success! configured.

ERROR:command is invalid! The command fails to be executed.

input error. invalid NewClusterEndPoint! The entered parameter value is incorrect.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 65


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

3.37 change newclusterendpoint


Function
Configures the IP address of the target cluster to which services are forwarded in a region.
When the change coexiststatus command is executed to set the status of service forwarding
to 1, the system will use the IP address to forward services.

Format
change newclusterendpoint <IP>

Parameters
Parameter Description Value

IP Private virtual service IP IPv4 address.


address of LVS of the target
cluster to which services are
forwarded to in a region.

Usage Guidelines
l The parameter value must comply with the format of IPv4.
l To use this IP address to forward services, you need to run the change coexiststatus
command to set the status of service forwarding to 1 after the IP address is successfully
configured.

NOTICE
Do not enable service forwarding immediately after the IP address is configured
successfully. Instead, enable service forwarding 5 minutes later to ensure that the newly
configured IP address has been dynamically loaded by the system and taken effect.

Example
cli@OMS01:~> change newclusterendpoint 127.0.0.2
SUCCESS:change NewClusterEndPoint success!

System Response
Output Information Instruction

SUCCESS:change NewClusterEndPoint The target cluster address is successfully


success! configured.

ERROR:command is invalid! The command fails to be executed.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 66


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Output Information Instruction

input error. invalid NewClusterEndPoint! The entered parameter value is incorrect.

3.38 change privateregion


Function
The change privateregion command is used to set the private region list.

Format
change privateregion <regionlist>

Parameters
Parameter Description Value

regionlist A specific private region list. The private For details, see the
region list consists of 1 to 1024 following table.
characters, excluding spaces.

The following table lists the possible values of regionlist.

Value of Description
regionslist

regionname A specific private region name.


If the command is executed in a non-default region, the value can
only be its region name.
If the command is executed in a default region, the value can be
any region name.

region1,region2 A list of specific private region names.


The command can be executed only in the default region.

null/NULL When the value is set to null or NULL, the private region
information is cleared and all private regions change to non-private
regions.

Usage Guidelines
l In a default region, you can set a private region list, which contains one or more private
regions.
l In a non-default region, only the current region can be set to a private region.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 67


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

l The private region information configured in the default region must be the same as that
configured in the non-default region. For example, if non-default region A is set to a
private region, it must also be set to a private region in the private region list in the
default region.
l To delete some regions from the private region list, you can set the private region again
by excluding the regions that you want to delete. For example, a region list contains a, b,
c, and d. If you want to delete b and c, set a private region list that contains only a and d.

Example
Example 1: set a private region.
cli@OMS01:~> change privateregion region-1 SUCCESS:change privateregion success!

Example 2: set multiple private regions.


cli@OMS01:~> change privateregion region-1,region-2 SUCCESS:change privateregion
success!

Example 3: clear private region information.


cli@OMS01:~> change privateregion NULL SUCCESS:change privateregion success!

System Response
Output Information Instruction

SUCCESS:change privateregion success! A private region is successfully set.

FAILED:input error, invalid region name! A private region is unsuccessfully set due to
an invalid region name.

Error! no such region name:${value}, In a single-region scenario, the region name


current region name is: ${regionNames} does not exist. A correct region name is
provided for reference.

Error! no such region name: ${item}! In a multi-region scenario, the region names
current region name list is: $ do not exist. A correct region list is
{regionNames}. provided for reference.

Warning! the region name: ${item} is An existing region name is entered again.
repeated, leaving only one The region name must be unique.

ERROR!The length of the input string must The input string is beyond 1-1024
be within 1 to 1024 after the space has been characters after excluding spaces.
removed

3.39 change taggingenable


Function
The change taggingenable command is used to enable or disable the tagging service.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 68


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change taggingenable <noticeinfo>

Parameters
Parameter Description Value

noticeinfo Service status. true: The true/false


service is enabled. false:
The service is disabled.
Default:false

Usage Guidelines
l Before enabling the tagging service, run the show billisforbucket command to check if
the value of billisforbucket is true. If yes, no future action is required. If no, run the
change billisforbucket true command..
l The command is a valid character string that contains true or false:
change taggingenable true
or
change taggingenable false

Example
cli@OMS01: > change taggingenable true
Please confirm whether billisforbucket is true? (y/n): [y]y
SUCCESS:change TaggingEnable success!

System Response
After the modification, you can check that the value of the service in
Tbl_TaggingEnable_Info_Set has been changed to the one in the command.
OMS01:~ # gsql -d xcatdb -U gaussdba -c "select * from
uds_1.\"Tbl_TaggingEnable_Info_Set\";"
Password for user gaussdba:
ID | VALUE
---------------+-------
TaggingEnable | true
(1 rows)

3.40 change bucketconcurrency


Function
The change bucketconcurrency command is used to set the value of bucketConcurrency in
the UDS configuration file. During a fast scan, the value is the maximum number of threads
allowed to concurrently scan for a bucket.

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 69


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Format
change bucketconcurrency <noticeinfo>

Parameters
Parameter Description Value

noticeinfo The maximum number of threads A positive integer larger


allowed to scan for a bucket than 0 but not larger than 30
during a fast scan.
Default:20

Usage Guidelines
l noticeinfo is a valid positive integer that cannot contain spaces, tab characters, and other
characters.
l The parameter value must be within the required range; otherwise, the command fails to
be executed, and an error is reported.

Example
cli@OMS02:~> change bucketconcurrency 10
SUCCESS:change bucketConcurrency success!

System Response
Run /opt/obs/obsconf/obs_sod.properties. If the value of bucketConcurrency is 10,
bucketConcurrency is successfully set.
OMS02:~ # grep bucketConcurrency /opt/obs/obsconf/obs_sod.properties
bucketConcurrency=10

3.41 change globalscanbucketflow


Function
The change globalscanbucketflow command is used to set the value of
globalScanBuketFlow in the UDS configuration file. During a fast scan, the value controls
whether all buckets use the single-node scan mode.

Format
change globalscanbucketflow <noticeinfo>

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 70


Copyright © Huawei Technologies Co., Ltd.
OceanStor UDS
CLI Command Reference 3 Setting Commands

Parameters
Parameter Description Value

noticeinfo During a fast scan, the value true | false


controls whether all buckets use
the single-node scan mode.
Default:false

Usage Guidelines
l If the value is true, all buckets use the single-node scan mode. If the value is false, none
of the buckets use the single-node scan mode.
l The parameter value must be within the required range; otherwise, the command fails to
be executed, and an error is reported.

Example
cli@OMS02:~> change globalscanbucketflow true
SUCCESS:change globalScanBucketFlow success!

System Response
Run /opt/obs/obsconf/obs_sod.properties. If the value of globalScanBucketFlow is true,the
single-node scan mode is successfully set.
OMS02:~ # grep globalScanBucketFlow /opt/obs/obsconf/obs_sod.properties
globalScanBucketFlow=true

Issue 01 (2017-05-12) Huawei Proprietary and Confidential 71


Copyright © Huawei Technologies Co., Ltd.

You might also like