下载
中文
注册

配置导入

配置导入功能包括:NTP服务配置,分区信息配置,主机名查询配置,域名解析配置、帐号密码过期天数配置、近端访问配置、会话过期时间配置、证书过期提前告警时间配置、登录规则配置和无线网络配置。

分区配置会影响业务,建议在业务部署前完成配置。partitions/ntp_server/device_location等为配置消息字段。其中:

  • 如果不带有partitions/ntp_server等字段,则不对原有配置做修改。
  • 如果带有partitions/ntp_server等字段,且数组内容为空,表示删除原来所有的配置。
  • 如果带有partitions/ntp_server等字段,且数组内容不为空,表示删除原来配置,按新的配置内容重新配置。

partitions具体配置规则如下:

  1. 根据device_location字段识别需要分区的设备;在device_location指定范围的设备,先删除原来用户分区(系统分区不能删除)。不在device_location指定范围的设备,保持原来配置。
  2. capacity_bytes的值小于512M,表示不创建分区,仅在1场景下,做删除分区使用;capacity_bytes为0时,除capacity_bytes和device_location需要正确填写外,其它字段可以为空。
  3. file_system只能支持ext4,其它格式不支持。
  4. mount_path为分区挂载路径。该字段不能为空,如果为空,创建的分区无挂载路径,会导致无法正常使用。
  5. 配置过程中出现失败,已经完成的配置不回滚,结果返回失败。
  6. “/var/lib/docker”路径不允许删除,允许重新挂载;如果本次分区挂载路径不包含“/var/lib/docker”,不管本次是否要对“/var/lib/docker”所挂载的设备进行分区,“/var/lib/docker”挂载的分区都保留;反之,如果本次重新挂载“/var/lib/docker”,不管是否对“/var/lib/docker”原来挂载的设备进行分区,都会删除该分区。

消息实例

{
    "header": {
        "msg_id": "741aec66-99b2-4d97-aaf2-63d27f53bbc5",
        "parent_msg_id": "",
        "timestamp": 1550107087319,
        "sync": false
    },
    "route": {
        "source": "controller",
        "group": "hardware",
        "operation": "update",
        "resource": "websocket/profile"
    },
    "content": {
    }
}

参数说明

content消息内容描述如下:

{
    "product": "Atlas 200I A2",
    "profile_name": "profile001",
    "config": {
        "ntp_server": {
            "service_enabled": true,
            "sync_net_manager": false,
            "preferred_server": "xx.xx.xx.xx",
            "alternate_server": "xx.xx.xx.xx"
        },
        "partitions": [{
            "capacity_bytes": 298999349248,
            "device": {
                "device_type": "SimpleStorage",
                "device_location": "HDD0"
            },
            "file_system": "ext4",
            "mount_path": "/home/data"
        }],
        "static_host_list": [{
            "ip_address": "xx.xx.xx.xx",
            "name": "fd.huawei.com"
        }],
        "name_server":[{
            "ip_address": "xx.xx.xx.xx"
        }],
        "security_policy":{
            "password_validity": "30",
            "web_access": true,
            "ssh_access": true,
            "session_timeout": 50,
            "cert_alarm_time": 20,
            "security_load": [{
                 "enable": "true",
                 "start_time": "00:00",
                 "end_time": "00:00",
                 "ip_addr": "xx.xx.xx.xx",
                 "mac_addr": "xx.xx.xx.xx.xx"
            }]
        },
        "lte_info": [
            {
                "apn_info": [
                    {
                        "apn_name": "123",
                        "apn_passwd": "",
                        "apn_user": "werfasew",
                        "auth_type": "2"
                    }
                ],
                "state_data": true,
                "state_lte": true
            }
        ]
    }
}

元素定义如下:

一级资源

二级资源

三级资源

四级资源

说明

product

-

-

-

含义:产品名称

类型:string

取值:1~64字节,支持数字、大小写字母、-、.、_和空格,不能包含“..“,且必须以数字或字母开头和结尾

profile_name

-

-

-

含义:配置文件名称

类型:string

取值:1~32字节,支持数字、大小写字母、-、.、_,不能包含“..”,且必须以数字或字母开头和结尾

config

-

-

-

含义:配置信息

类型:dict

-

ntp_server

-

-

含义:NTP服务配置

类型:dict

-

-

service_enabled

-

含义:NTP使能开关

类型:bool

取值:true或false

-

-

sync_net_manager

-

含义:是否同步网管时间

类型:bool

取值:

  • true:表示同步网管时间
  • false:表示不同步网管时间

-

-

preferred_server

-

含义:首选NTP服务器

类型:string

取值:当前仅支持IPv4地址。

  • 如果该字段为空,表示删除配置
  • 仅当service_enabled字段为true,并且sync_net_manager为false时该字段允许配置,同时不允许跟alternate_server使用相同的IP

-

-

alternate_server

-

含义:备用NTP服务器

类型:string

取值:仅支持IPv4地址。

  • 如果该字段为空,表示删除配置
  • 仅当service_enabled字段为true,并且sync_net_manager为false时该字段允许配置,可以配置为空,但不允许跟preferred_server使用相同的IP

-

partitions

-

-

含义:分区信息

取值:单个物理盘最多支持16个分区

-

-

capacity_bytes

-

含义:分区容量

类型:Int64

取值:小于等于磁盘最大剩余空间,必须是MB的整数倍

-

-

device

-

含义:存储设备

类型:dict

-

-

-

device_type

含义:磁盘媒介类型

类型:string

取值:仅支持SimpleStrorage和Volume

-

-

-

device_location

含义:磁盘位置

类型:string

取值:

  • 如果device_type为Volume,该字段填Volume的Name
  • 如果device_type为SimpleStorage,该字段填磁盘的物理位置
  • 长度不超过256,支持支持数字、大小写字母和其他字符(-_.),不能包含..

-

-

file_system

-

含义:文件系统类型

类型:string

取值:当前仅支持ext4,不传时,默认为ext4

-

-

mount_path

-

含义:分区挂载绝对路径

类型:string

取值:0~256字节,取值不为0时必须以'/'开头,字符串内不能带空格

-

static_host_list

-

-

含义:主机名查询静态表

取值:表示全量配置,直接覆盖系统已经配置的。

最大支持配置128条,不包括系统自带localhost和预置的FusionDirector域名(可配置,未配置默认为fd.fusiondirector.huawei.com),这两部分不能修改和配置。

允许多个IP对应同一个域名或一个域名对应多个IP,FusionDirector和设备均不做限制,由用户保证配置正确性。

-

-

ip_address

-

含义:IP地址

类型:string

取值:支持IPv4,允许配置相同的IP指向不同的域名/主机名

-

-

name

-

含义:域名/主机名

类型:string

取值:域名可以由英文字母(不区分大小写)、数字、连接符"-"以及"."组成,最长支持253字节,此处不区分主机名还是域名。

localhost、localhost.localdomain、localhost4、localhost4.localdomain4、localhost6、localhost6.localdomain6、FusionDirector域名(可配置,未配置默认为fd.fusiondirector.huawei.com),这几个名称保留,不能配置,不区分大小写。

-

name_server

-

-

含义:域名解析服务器

取值:表示全量配置,直接覆盖系统已经配置的。最多支持配置3条

-

-

ip_address

-

含义:IP地址

类型:string

取值:支持IPv4地址

-

security_policy

-

-

帐号和密码过期天数

-

-

password_validity

-

含义:帐号和密码过期天数

类型:string

取值:范围0-365,仅支持数字。

-

-

web_access

-

含义:是否打开web近端接入开关,不传该字段表示不更改此项配置

类型:bool

取值:true或者false

-

-

ssh_access

-

含义:是否打开ssh近端接入开关,不传该字段表示不更改此项配置

类型:bool

取值:true或者false

-

-

session_timeout

-

含义:会话超时时间,单位为分钟

类型:string

取值:5~120

-

-

cert_alarm_time

-

含义:证书过期提前告警时间,单位为天

类型:string

取值:7~180

-

-

security_load

-

含义:登录规则

类型:list

取值:最大支持30个

-

-

-

enable

含义:是否使能本条登录规则黑名单

类型:string

取值:true or false

-

-

-

start_time

含义:登录规则黑名单生效开始时间

类型:string

取值:合法时间格式

-

-

-

end_time

含义:登录规则黑名单生效结束时间

类型:string

取值:合法时间格式

-

-

-

ip_addr

含义:允许登录的IP地址

类型:string

取值:合法的IPV4地址,可以有xxx.xxx.xxx.xxx或者xxx.xxx.xxx.xxx/mask两种形式,xxx.xxx.xxx.xxx为单个IP地址,xxx.xxx.xxx.xxx/mask为IP地址段

-

-

-

mac_addr

含义:允许登录的mac地址

类型:string

取值:合法的mac地址

-

lte_info

-

-

含义:无线网络配置

取值:有且只有1条配置

-

-

state_lte

-

含义:无线网络的开关状态。

类型:bool

  • true:打开。
  • false:关闭。

-

-

state_data

-

含义:移动数据的开关状态。

类型:bool

  • true:打开。
  • false:关闭。

-

-

apn_info

-

含义:APN配置信息

类型:数组。

取值:最多1条配置。

-

-

apn_info[].apn_name

-

含义:拨号时使用的APN名称。

类型:字符串。

取值:可由大小写字母(a~z、A~Z)、数字(0~9)和其他字符(_-.@)组成,最大长度为39字符。

-

-

apn_info[].apn_passwd

-

含义:拨号时使用的APN密码。

类型:字符串。

取值:最大长度为64字符,由数字、大小写字母及除英文逗号和英文引号的其他英文特殊符号组成。

-

-

apn_info[].apn_user

-

含义:拨号时使用的APN用户名。

类型:字符串。

取值:可由大小写字母(a~z、A~Z)、数字(0~9)和其他字符(-_.@)组成,最大长度为64字符。

-

-

apn_info[].auth_type

-

含义:身份验证类型。

类型:字符串。

取值为0、1、2、3,其含义分别为:

  • 0:NONE
  • 1:PAP
  • 2:CHAP
  • 3:PAP or CHAP
说明:

4G模块支持的auth_type取值为0、1、2;5G模块支持的auth_type的取值为0、1、2、3。

返回结果

{
    "header":{
        "msg_id":"02bb6421-45b4-4f0c-914c-ef3183a37000",
        "parent_msg_id": "",
        "timestamp":1652278267211,
        "sync": false
    },
    "route":{
        "source":"hardware",
        "group":"hub",
        "operation":"update",
        "resource":"websocket/profile"
    },
    "content":"SUCCESS"|"FAILED: input param check failed"
}