< Home

Data Model

The data model file matching the device status information module is huawei-device.yang.

Table 1 Device status information

Object

Description

Value

Remarks

device-state

Indicates the root object of device status information. It is only used to contain sub-objects, but does not have any data meaning.

-

N/A

device-state/model

Indicates the device model.

The value is a string of 1 to 35 characters.

N/A

device-state/esn

Indicates the chassis ESN.

The value is a string of 1 to 32 characters.

N/A

device-state/mac-address

Indicates the device MAC address.

The value is a character string, for example: xx:xx:xx:xx:xx:xx.

N/A

device-state/vendor

Indicates the device vendor.

The value is a character string Huawei.

N/A

device-state/version

Indicates the system software version.

The value is a string of 1 to 127 characters.

N/A

device-state/patch-version

Indicates the patch version.

The value is a string of 1 to 127 characters.

N/A

device-state/name

Indicates the device host name.

The value is a character string.

N/A

device-state/clock/current-datetime

Indicates the current system time.

The value is a string of 1 to 100 characters.

N/A

device-state/clock/boot-datetime

Indicates the system startup time.

The value is a string of 1 to 100 characters.

N/A

device-state/clock/up-times

Indicates the system running duration.

The value is a string of 1 to 100 characters.

N/A

device-state/clock/mode-change-datetime

Indicates the time when the device mode is changed to NETCONF.

The value is a string of 1 to 100 characters.

N/A

device-state/performance/cpu-using-rate

Indicates the current device CPU usage.

The value is an integer that ranges from 0 to 100, in percentage. For example, the value 9 indicates that the current device CPU usage is 9%.

N/A

device-state/performance/memory-using-rate

Indicates the current device memory usage.

The value is an integer that ranges from 0 to 100, in percentage. For example, the value 11 indicates that the current device memory usage is 11%.

N/A

device-state/user-define-info/stack-status

Indicates whether the switch is a stacked switch.

The value is of the enumerated type:
  • single: standalone mode

  • stack: stack mode

If the slot ID of a switch is 0 and the switch has no stack port configured when using service port stacking, the switch works in standalone mode. Otherwise, the switch works in stack mode.

N/A

device-state/user-define-info/system-mac-address

Indicates the stack MAC address.

The value is a character string in the format xx:xx:xx:xx:xx:xx.

This field is empty when the stacking function is disabled. In a single-switch stack, this field displays the device system MAC address.

N/A

device-state/user-define-info/local-manage-ip

Indicates the IP address used by the device to communicate with the iMaster NCE-Campus.

The value is a character string in dotted decimal notation.

Only the switches supporting NETCONF support this object.

device-state/upstream-interfaces/interface

Indicates the upstream interfaces.

The value is a string of 1 to 100 characters.

Only the switches supporting NETCONF support this object.

device-state/upstream-interfaces/management-vlan-id

Indicates the management VLAN used by the device to communicate with the iMaster NCE-Campus.

The value is an integer that ranges from 1 to 4094.

Only the switches supporting NETCONF support this object.

device-state/upstream-interfaces/management-vlan-ip

Indicates the management IP address used by the device to communicate with the iMaster NCE-Campus.

The value is a character string in dotted decimal notation.

Only the switches supporting NETCONF support this object.

device-state/optical-module-infos

Indicates information about the optical module installed in an interface.

-

N/A

device-state/optical-module-infos/interface-list/interface-name

Specifies the name of an interface.

The value is a string of characters.

N/A

device-state/optical-module-infos/interface-list/physical-index

Indicates the sequence number of an interface.

The value is an integer.

N/A

device-state/optical-module-infos/interface-list/present

Indicates whether an optical module is available on an interface.

The value is of the Boolean type:

  • true: The optical module is available on the interface.
  • false: No optical module is available on the interface.

NA

device-state/optical-module-infos/interface-list/optical-module-info/vendor-name

Indicates the manufacturer of an optical module.

The value is a string of characters.

N/A

device-state/optical-module-infos/interface-list/optical-module-info/serial-number

Indicates the serial number of an optical module.

The value is a string of characters.

N/A

device-state/optical-module-infos/interface-list/optical-module-info/type

Indicates the type of an optical module.

The value is of the enumerated type:

  • unknown
  • sc
  • gbic
  • sfp
  • esfp
  • rj45
  • xfp
  • xenpak
  • transponder
  • cfp
  • smb
  • sfpplus
  • cxp
  • qsfp
  • qsfpplus
  • cfp2
  • dwdmsfp
  • msa100glh
  • gps
  • csfp
  • cfp4
  • qsfp28
  • sfpsfpplus
  • gponsfp
  • cfp8
  • sfp28
  • qsfpdd
  • cfp2dco

NA

device-state/optical-module-infos/interface-list/optical-module-info/transfer-mode

Indicates the transmission mode of an optical module.

The value is of the enumerated type:

  • not-support
  • single-mode
  • multi-mode-5
  • multi-mode-6
  • no-value
  • gps-mode
  • copper-mode
  • single-and-multi-Mode

NA

device-state/optical-module-infos/interface-list/optical-module-info/tx-power-high-threshold

Indicates the upper threshold of the transmit power for an optical module.

The value is a floating point number rounded to two decimal places.

N/A

device-state/optical-module-infos/interface-list/optical-module-info/tx-power-low-threshold

Indicates the lower threshold of the transmit power for an optical module.

The value is a floating point number rounded to two decimal places.

NA

device-state/optical-module-infos/interface-list/optical-module-info/rx-power-high-threshold

Indicates the upper threshold of the receive power for an optical module.

The value is a floating point number rounded to two decimal places.

N/A

device-state/optical-module-infos/interface-list/optical-module-info/rx-power-low-threshold

Indicates the lower threshold of the receive power for an optical module.

The value is a floating point number rounded to two decimal places.

N/A

system-restart

Indicates an rpc method used to restart the device.

-

N/A

register-status-notify

Indicates an rpc method that is used by the controller to send registration result.

-

N/A

slave-switchover/reason-id

Indicates an rpc method used by the controller to instruct the switch to perform an active/standby switchover.

The value must be switchover-by-controller.

N/A

register-status-notify/register-success

Indicates the device registration status.

The value is of the Boolean type:
  • true: The device succeeds in registration.
  • false: The device fails registration.

N/A

register-status-notify/register-fail-reason

Indicates that the device fails registration. It also returns an error code.

The value is an integer.

N/A

get-board-reboot-type/slot-index

Displays the reset reason of a specified slot.

If this object is not specified, the reset reasons of all slots are displayed.

The value is a character string, which corresponds to a slot ID, for example, 1.

N/A

get-board-reboot-type/reboot-type-list/slot-index

Indicates the slot ID of the board that resets.

The value is a character string.

N/A

get-board-reboot-type/reboot-type-list/time

Indicates the time a reset occurs.

The value is a character string.

N/A

get-board-reboot-type/reboot-type-list/reboot-type

Indicates the reset reason, including MANUAL, POWER, SCHEDU, FSP, EXCEPTION, VRP, SOFTWARE, and OTHER.

The value is a character string.

N/A

get-board-history-reset-reason/slot-index

Displays the historical reset reason of a specified slot. This object must be specified.

The value is a character string, which corresponds to a slot ID, for example, 1.

N/A

get-board-history-reset-reason/reason-list/slot-index

Indicates the slot ID for historical reset information.

The value is a character string.

N/A

get-board-history-reset-reason/reason-list/reset-time

Indicates the time a historical reset occurs.

The value is a character string.

N/A

get-board-history-reset-reason/reason-list/reason

Indicates a historical reset reason.

The value is a character string.

N/A

get-system-reset-reason/name

Indicates the offline reason number of a switch.

The value is a character string.

Only the switches supporting NETCONF support this object.

get-system-reset-reason/time

Indicates the offline time.

The value is a character string.

Only the switches supporting NETCONF support this object.

get-system-reset-reason/reason

Indicates the offline reason.

The value is a character string.

Only the switches supporting NETCONF support this object.

get-system-connect-fail-reason/time

Indicates the time the switch fails to go online.

The value is a character string.

Only the switches supporting NETCONF support this object.

get-system-connect-fail-reason/reason

Indicates the online failure reason.

The value is a character string.

Only the switches supporting NETCONF support this object.

get-board-file-info/file-path

Indicates the path name of a file.

The value is a string of 1 to 255 characters.

N/A

delete-board-file/file-name

Indicates the file name with full path.

The value is a string of 1 to 255 characters.

N/A

Copyright © Huawei Technologies Co., Ltd.
Copyright © Huawei Technologies Co., Ltd.
Next topic >