Reporting Static System Information

The static system information is triggered by the edge side in the following cases:

  1. If the system information changes due to configuration operations such as firmware upgrade, the system reports the change in a timely manner.
  2. The change is reported every 2 minutes.

Message instance

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

Parameter description

The content message is described as follows:

{
    "product_info": {
        "manufacturer": "Huawei",
        "product_name": "Atlas 200",
        "support_model": "Atlas 200 I A2",
        "serial_number": "asdf45dsf3sdg",
        "pcb_version": "Ver.C",
        "os_version": "EulerOS V100R001C01",
        "kernel_version": "2.6.3",
        "software_version": "1.0.0",
        "asset_tag": "123456",
        "cpuArchitecture": "ARM"
    },
    "product_capability_om": [
        "profile",
        "Assettag",
        "restart",
        "firmware_install",
        "info_collect",
        "rearm",
        "hostname_config",
        "ntp_server_config",
        "partition_config",
        "static_host_config",
        "name_server_config",
        "nfs_config",
        "net_manager_config",
        "password_config",
        "password_validity_config",
        "configuration_restore",
        "cert_mgmt",
        "lte_config",
        "access_control",
        "session_timeout_config",
        "cert_alarm_time_config",
        "security_load_config"
    ],
    "system": {
        "host_name": "Atlas200",
        "cpu_count": 1,
        "cpu_model": "Hi3559A",
        "memory_size": "4GB",
        "storage_size": "512GB",
        "inactive_firmware": "software",
        "inactive_configuration": "",
        "net_manager_domain": "fd.fusiondirector.huawei.com",
        "net_manager_address": "10.35.22.33",
        "net_manager_account": "edgeAccount"
    },
    "ntp_server": {
        "ntp_info_invalid": false,
        "service_enabled": true,
        "sync_net_manager": false,
        "preferred_server": "xx.xx.xx.xx",
        "alternate_server": "xx.xx.xx.xx"
    },
    "partitions": [{
        "name": "/dev/sda1",
        "capacity_bytes": 134217728,
        "storage_name": "eMMC",
        "storage_device": "/dev/sda",
        "storage_location": "HDD0",
        "file_system": "ext4",
        "mount_path": "/home/data",
        "system_partition_flag": true,
        "logic_name": "sda1"
    }],
    "ai_processors": [{
        "id": 1,
        "manufacturer": "Huawei",
        "model": "Hi1910",
        "calc_ability": "16T",
        "ddr_capacity": "4GB",
        "location": "HDD0"
    }],
    "extended_devices": [{
        "name": "SATADISK1",
        "device_type": "HDD",
        "device_name": "/dev/sda",
        "manufacturer": "Seagate",
        "model": "Hi3559AGMAC",
        "serial_number": "XXXX",
        "firmware_version": "XXXX",
        "location": "HDD0"
    }],
    "ethernet_interfaces": [{
        "id": "GMAC1",
        "name": "eth0",
        "description": "EthernetInterfaceoverWiredNetworkAdapter",
        "permanent_mac": "xx:xx:xx:xx:xx:xx",
        "mac": "xx:xx:xx:xx:xx:xx",
        "interface_enabled": true,
        "ipv4_addresses": [{
            "address": "xx.xx.xx.xx",
            "subnet_mask": "255.255.0.0",
            "gateway": "xx.xx.xx.xx",
            "address_origin": "Static",
            "tag": "Mgmt"
        }],
        "name_servers": ["xx.xx.xx.xx"],
        "location":"PORT2",
        "adapter_type": "GMAC",
        "lte_data_switch": "enable"
    }],
    "simple_storages": [{
        "name": "eMMC1",
        "type": "eMMC",
        "description": "SystemeMMCFlash",
        "devices": [{
            "name": "/dev/sda",
            "manufacturer": "Huawei",
            "model": "3000GT8",
            "capacity_bytes": 32000000000,
            "reserved_bytes": 3200,
            "partition_style": "GPT",
            "location": "HDD0"
        }]
    }],
    "firmware_list": [{
        "name": "MindXOM",
        "version": "1.0.2",
        "inactive_version": "1.0.3",
        "active_method": "inband",
        "board_id": "",
        "upgrade_agent": "OM"
    }],
    "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": "180",
        "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"
        }]
    },
    "accounts": [
        "admin",
        "user"
    ],
    "lte_info": {
    }
}

Elements are defined as follows:

Level-1 Resource Name

Level-2 Resource Name

Level-3 Resource Name

Description

product_info

-

-

Product information

-

manufacturer

-

Meaning: manufacturer

Type: string

Value: 32 bytes

-

product_name

-

Meaning: product name

Type: string

Value: 64 bytes

-

support_model

-

Meaning: product model

Type: string

Value: Atlas 200I A2

-

serial_number

-

Meaning: serial number

Type: string

Value: 64 bytes

-

pcb_version

-

Meaning: PCB version

Type: string

Value: 32 bytes

-

os_version

-

Meaning: OS version

Type: string

Value: 64 bytes

-

kernel_version

-

Meaning: kernel version

Type: string

Value: 32 bytes

-

software_version

-

Meaning: software version

Type: string

Value: 32 bytes

-

asset_tag

-

Meaning: customized asset tag

Type: string

Value: 255 bytes

-

cpuArchitecture

-

Meaning: CPU architecture type

Type: string

Value: x86 or Arm

product_capability_om

-

-

Product capability

-

profile

-

Meaning: configuration import

Type: string

-

Assettag

-

Meaning: asset tag

Type: string

-

restart

-

Meaning: supporting system restart

Type: string

-

firmware_install

-

Meaning: supporting firmware upgrade

Type: string

-

info_collect

-

Meaning: information collection

Type: string

-

rearm

-

Meaning: alarm reporting

Type: string

-

hostname_config

-

Meaning: supporting host name configuration

Type: string

-

ntp_server_config

-

Meaning: supporting the NTP service

Type: string

-

partition_config

-

Meaning: supporting drive management

Type: string

-

static_host_config

-

Meaning: supporting local static configuration

Type: string

-

name_server_config

-

Meaning: supporting domain name resolution

Type: string

-

nfs_config

-

Meaning: supporting NFS configuration

Type: string

-

net_manager_config

-

Meaning: supporting network management configuration

Type: string

-

password_config

-

Meaning: local password change

Type: string

-

password_validity_config

-

Meaning: local password validity

Type: string

-

configuration_restore

-

Meaning: automatic backup and restoration capability

Type: string

-

cert_mgmt

-

Meaning: supporting certificate management

Type: string

-

lte_config

-

Meaning: supporting LTE configuration

Type: string

-

access_control

-

Meaning: enabling or disabling the local access capability

Type: string

-

session_timeout_config

-

Meaning: session timeout interval

Type: string

-

cert_alarm_time_config

-

Meaning: certificate expiry notification time

Type: string

-

security_load_config

-

Meaning: secure login rule

Type: string

system

-

-

System information

-

host_name

-

Meaning: host name

Type: string

Value: 64 bytes

-

cpu_count

-

Meaning: number of CPUs

Type: int32

-

cpu_model

-

Meaning: CPU model

Type: string

Value: 32 bytes

-

memory_size

-

Meaning: system memory size

Type: string

Value: 32 bytes

-

storage_size

-

Meaning: system storage size

Type: string

Value: 32 bytes

-

inactive_firmware

-

Meaning: name of the inactive firmware

Type: string

Value: 32 bytes

-

inactive_configuration

-

Meaning: name of the inactive configuration file

Type: string

Value: 32 bytes. If there are multiple inactive configuration files, only one of them is displayed. If there is no inactive configuration file, null is returned.

-

net_manager_domain

-

Meaning: NMS domain name

Type: string

Value: 64 bytes

-

net_manager_address

-

Meaning: NMS IP address

Type: string

Value: 64 bytes

-

net_manager_account

-

Meaning: NMS account

Type: string

Value: 32 bytes

ntp_server

-

-

NTP server

-

ntp_info_invalid

-

Meaning: whether the NTP server information is valid

Type: bool

Value: true or false

The default value of FusionDirector is false, indicating that the node does not report this field and the entire ntp_server data is valid.

-

service_enabled

-

Meaning: whether the NTP service is enabled

Type: bool

Value: true or false

If the value is set to false, the active and standby servers cannot be configured.

-

sync_net_manager

-

Meaning: NMS NTP enablement flag

Type: bool

Value: true or false

-

preferred_server

-

Meaning: preferred NTP server

Type: string

Value: only IPv4 addresses are supported.

-

alternate_server

-

Meaning: alternate NTP server

Type: string

Value: only IPv4 addresses are supported.

partitions

-

-

Partition information

-

name

-

Meaning: physical device name

Type: string

Value: 32 bytes. The format is /dev/+device partition name.

-

capacity_bytes

-

Meaning: total partition size

Type: int64

The value cannot exceed the maximum free space of the drive. The value must be an integer in MB.

-

storage_name

-

Meaning: storage medium name

Type: string

Value: 32 bytes For simple storage, set the value to the corresponding storage medium type. For a volume, set the value to volume.

-

storage_device

-

Meaning: storage device

Type: string

Value: 32 bytes. If the medium type is volume, the value is the same as that of storage_location.

-

storage_location

-

Meaning: storage device location

Type: string

Value: 32 bytes

-

file_system

-

Meaning: file system format

Type: string

Value: only ext4 is supported at present.

-

mount_path

-

Meaning: mount path

Type: string

Value: 256 bytes

-

system_partition_flag

-

Meaning: system partition flag

Type: bool

Value: true or false

-

logic_name

-

Meaning: logical partition name

Type: string

ai_processors

-

-

AI processor information

-

id

-

Meaning: chip ID

Type: int

Value: currently, there is only one chip. The default value is 0.

-

manufacturer

-

Meaning: manufacturer

Type: string

Value: 32 bytes

-

model

-

Meaning: chip model

Type: string

Value: 32 bytes

-

calc_ability

-

Meaning: computing power

Type: string

Value: 32 bytes. Currently, there are two specifications: 16 TB and 22 TB.

-

ddr_capacity

-

Meaning: DDR memory size

Type: string

Value: 32 bytes. Currently, there are two specifications: 4 GB and 8 GB.

-

location

-

Meaning: AI processor location

Type: string

Value: 32 bytes

extended_devices

-

-

External device

-

name

-

Meaning: device name

Type: string

Value: 32 bytes

-

device_type

-

Meaning: device type

Type: string

-

device_name

-

Meaning: system device name

Type: string

Value: 32 bytes. The format is /dev/+device name, for example, /dev/sd1.

-

manufacturer

-

Meaning: manufacturer

Type: string

Value: 32 bytes

-

model

-

Meaning: device model

Type: string

Value: 32 bytes

-

serial_number

-

Meaning: serial number

Type: string

Value: 64 bytes

-

firmware_version

-

Meaning: firmware version

Type: string

Value: 64 bytes

-

location

-

Meaning: physical location

Type: string

Value: 32 bytes

ethernet_interfaces

-

-

Ethernet interface information

-

id

-

Meaning: network port ID

Type: string

Value:

32 bytes. The format is AdapterType+number (starting from 1). The options of AdapterType are as follows:

  • GMAC: Ethernet port
  • Wifi
  • LTE

-

name

-

Meaning: network port name

Type: string

Value: a maximum of 32 bytes

  • A common network port is named in the format of eth+number.
  • LTE: wwan+number
  • Wifi: wlan+number

-

description

-

Meaning: description of a network port

Type: string

Value: a maximum of 256 bytes

-

permanent_mac

-

Meaning: permanent MAC address that is permanently burnt during production

Type: string

Value: 18 bytes

-

mac

-

Meaning: MAC address actually used by a user

Type: string

Value: 18 bytes

-

interface_enabled

-

Meaning: network port enablement flag

Type: bool

Value: true or false

-

ipv4_addresses

-

Meaning: IPv4 address

Type: list

Value: a maximum of 16

-

-

address

Meaning: IP address

Type: string

Value: an IPv4 address

-

-

subnet_mask

Meaning: subnet mask

Type: string

Value: an IPv4 address

-

-

gateway

Meaning: gateway

Type: string

Value: an IPv4 address

-

-

address_origin

Meaning: address source

Type: string

Value: Static or DHCP

-

-

tag

Meaning: IP address tag

Type: string

Value: a maximum of 32 bytes

-

name_servers

-

Meaning: DNS address

Type: string

Value: IPv4 address. A maximum of two IPv4 addresses can be configured.

-

adapter_type

-

Meaning: network access mode

Type: string

Value: GMAC, Wifi, or LTE

-

lte_data_switch

-

Meaning: LTE data switch

Type: string

Value: enable or disable. This parameter is left empty for non-LTE network ports.

-

location

-

Meaning: physical location

Type: string

Value: a maximum of 32 bytes

simple_storages

-

-

Simple storage information

-

name

-

Meaning: name

Type: string

Value: a maximum of 32 bytes

-

type

-

Meaning: storage medium type

Type: string

Value: a maximum of 32 bytes

-

description

-

Meaning: description of a network port

Type: string

Value: a maximum of 256 bytes

-

devices

-

Meaning: storage device

Type: list

-

-

name

Meaning: system device name. It starts with /dev/, indicating a system device.

Type: string

Value: 32 bytes

-

-

manufacturer

Meaning: manufacturer

Type: string

Value: 32 bytes

-

-

model

Meaning: device model

Type: string

Value: 32 bytes

-

-

capacity_bytes

Meaning: storage space total size

Type: int64

-

-

reserved_bytes

Meaning: size of reserved system space

Type: int64

Value: smaller than the value of capacity_bytes

-

-

partition_style

Meaning: partition mode

Type: string

Value: 32 bytes

-

-

location

Meaning: physical location for devices

Type: string

Value: 256 bytes

firmware_list

-

-

List of firmware that can be upgraded

-

name

-

Meaning: firmware name

Type: string

Value: 32 bytes

-

version

-

Meaning: version of the current running firmware

Type: string

Value: 32 bytes

-

inactive_version

-

Meaning: version of the inactive firmware

Type: string

Value: 256 bytes

-

active_method

-

Meaning: active method

Type: string

Value: inband, outband, or auto.

-

board_id

-

Meaning: board ID

Type: string

Value: 256 bytes

-

upgrade_agent

-

Meaning: upgrade agent

Type: string

Value: OM

static_host_list

-

-

Meaning: static table for host name query

Value: a maximum of 128 rules can be configured, which is ensured by the FusionDirector and is not limited by the underlying layer. Only the user configuration result is included. The following information is not reported:

  • The default localhost and preset fd.fusiondirector.huawei.com are not reported.
  • If name contains more than 256 bytes or contains invalid characters other than 0-9/a-z/A-Z/./-, the information is not reported.

-

ip_address

-

Meaning: static DNS server address

Type: string

Value: only IPv4 addresses are supported.

-

name

-

Meaning: static domain name information

Type: string

Value: 64 bytes

name_server

-

-

Meaning: domain name server

Value: a maximum of 3

-

ip_address

-

Meaning: DNS address

Type: string

Value: only IPv4 addresses are supported.

security_policy

-

-

Security policy

-

password_validity

-

Meaning: password validity

Type: string

Value: 0 to 365. The value 0 indicates that the password never expires.

-

web_access

-

Meaning: whether to enable the web local access

Type: bool

Value: true or false

-

ssh_access

-

Meaning: whether to enable the SSH local access

Type: bool

Value: true or false

-

session_timeout

-

Meaning: session timeout interval, in minutes

Type: int

Value: 5 to 120

-

cert_alarm_time

-

Meaning: certificate expiry notification time, in days

Type: int

Value: 7 to 180

-

security_load

-

Meaning: login rule

Type: list

Value: a maximum of 30

-

-

enable

Meaning: whether to enable the login rule blocklist

Type: bool

Value: true or false

-

-

start_time

Meaning: start time of the validity period of the login rule blocklist

Type: string

Value: valid time format

-

-

end_time

Meaning: end time of the validity period of the login rule blocklist

Type: string

Value: valid time format

-

-

ip_addr

Meaning: forbidden IP address for login

Type: string

Value: a valid IPv4 address in the format of xxx.xxx.xxx.xxx (a single IP address) or xxx.xxx.xxx.xxx/mask (an IP address segment)

-

-

mac_addr

Meaning: forbidden MAC address for login

Type: string

Value: a valid MAC address

accounts

-

-

Meaning: user name list

Type: list

Value: 64 bytes

QoS Guarantee Attributes

To ensure the normal running of MindEdge OM and avoid frame freezing or slow upload and download, the network bandwidth must meet the following requirements:

  • The bandwidth between the edge device where MindEdge OM is located and FusionDirector must be greater than or equal to 50 Mbit/s.
  • Other network requirements: latency < 30 ms, packet loss rate < 3%