Asus ASMB9-iKVM Manual

Asus Ikke kategoriseret ASMB9-iKVM

Læs nedenfor 📖 manual på dansk for Asus ASMB9-iKVM (200 sider) i kategorien Ikke kategoriseret. Denne guide var nyttig for 13 personer og blev bedømt med 4.5 stjerner i gennemsnit af 7 brugere

Download PDF

Side 1/200

Server Management Board

ASMB9-iKVM

User Guide

Contents

Notices vii ......................................................................................................................

Safety information ix ......................................................................................................

About this guide x ..........................................................................................................

ASMB9-iKVM specifications summary.................................................................... xii

Chapter 1: Product Introduction

1.1 Welcome! .................................................................................................... 1-2

1.2 Package contents 1-2 ......................................................................................

1.3 Features ...................................................................................................... 1-3

1.4 System requirements 1-4 .................................................................................

1.5 Network setup 1-5 ............................................................................................

Chapter 2: Hardware Information

2.1 Before you proceed 2-2 ...................................................................................

2.2 Hardware installation 2-2 .................................................................................

2.3 Firmware update and IP configuration 2-3 .....................................................

2.4 BIOS configuration 2-6 ....................................................................................

2.5 Server Mgmt menu 2-7 .....................................................................................

2.6 Running the ASMC8 utility 2-11 ......................................................................

Chapter 3: Web-based User Interface

3.1 Web-based user interface 3-2 .........................................................................

3.2 Dashboard .................................................................................................. 3-4

3.3 Sensor ......................................................................................................... 3-4

3.4 FRU Information 3-5 .........................................................................................

Contents

3.5 Logs & Reports 3-5 ..........................................................................................

3.6 Settings ....................................................................................................... 3-9

3.7 Remote Control 3-19 ........................................................................................

3.8 Image Redirection 3-22 ....................................................................................

3.9 Power Control 3-22 ...........................................................................................

3.10 Maintenance .............................................................................................3-23

Chapter 4: Redfish Technology Pack

4.1 Redfish introduction 4-2 ..................................................................................

4.2 Redfish API 4-3 .................................................................................................

4.3 Redfish Resources 4-11 ...................................................................................

Contents

4.4 Redfish AMI OEM Entities 4-122 .....................................................................

4.5 Known Limitations 4-125 .................................................................................

Appendix

A.1 LAN ports for server management A-2 ..........................................................

A.2 Troubleshooting ........................................................................................ A-3

A.3 Sensor Table.............................................................................................. A-4

A.4 Redfish Assigned Privileges A-12 ..................................................................

A.5 Redfish Reference documents A-14 ..............................................................

Simplified EU Declaration of Conformity A-15 ............................................................

ASUS contact information A-16 ....................................................................................

Notices

Federal Communications Commission Statement

Compliance Statement of Innovation, Science and Economic

Development Canada (ISED)

Déclaration de conformité de Innovation, Sciences et

Développement économique Canada (ISED)

REACH

ASUS Recycling/Takeback Services

DO NOT

About this guide

How this guide is organized

• Chapter 1: Product Introduction

• Chapter 2: Hardware Information

• Chapter 3: Web-based user interface (ASMB9-iKVM only)

• Chapter 4: Redfish Technology Pack

• Appendix

Where to find more information

1. ASUS websites

2. Optional documentation

Conventions used in this guide

DANGER/WARNING:

CAUTION:

IMPORTANT:

NOTE:

Typography

Bold text

Italics

Command

format A:/S

ASMB9-iKVM specifications summary

Chipset

Internal RAM

Internal ROM

Timers

Main features

Form factor

* Specifications are subject to change without notice.

Product Introduction

Chapter 1: Product Introduction

1.1 Welcome!

1.2 Package contents

1.3 Features

1. IPMI 2.0

2. Private I2C Bus

3. PMBus*

4. PSMI*

5. Web-based GUI

6. Update Firmware

1.4 System requirements

* A power supply supported PMBus and PSMI is necessary.

** Specifications are subject to change without notice.

7. Notification

8. KVM over Internet

9. Remote Update BIOS

10. Remote Storage (Virtual Media)

11. Remote Install OS

12. Supports SNMB MIB file

13. User interface

1.5 Network setup

Remote server

with ASMB9-iKVM

Hub or router

Direct LAN connection

LAN connection through a network hub

Remote server

with ASMB9-iKVM

RJ-45 cable

Remote console with web-

based browser

Remote console with web-

based browser

Hardware Information

Chapter 2: Hardware Information

2.2 Hardware installation

2.1 Before you proceed

2.3 Firmware update and IP configuration

2.3.1 Firmware update

ASMB9-iKVM Firmware Update for Clear Configuration

FreeDOS command prompt

Configure BMC IP Source Static IP for Shared LAN

Configure BMC IP Source DHCP IP for Shared LAN

Configure BMC IP Source Static IP for DM_LAN1

Configure BMC IP Source DHCP IP for DM_LAN1

ASMB9 Firnware Updated for Preserve Configuration (SDR, LAN, Username)

ASMB9 Firnware Updated for Clear Configuration (SDR, LAN, Username)

ASUS Server Z11PP-D24 Series System

WARNING !!!

UPDATE ASMB9 FIRMWARE NOW !

DO YOU WANT TO CONTINUE ?

No Yes

3.10

Maintenance

2.3.2 Configure BMC IP source static IP

Configure BMC IP Source Static IP for Shared LAN (or DM_LAN1)

from the main menu

2.5.2 BMC network

configuration

FreeDOS command prompt

Configure BMC IP Source Static IP for Shared LAN

Configure BMC IP Source DHCP IP for Shared LAN

Configure BMC IP Source Static IP for DM_LAN1

Configure BMC IP Source DHCP IP for DM_LAN1

ASMB9 Firnware Update for Preserve Configuration (SDR, LAN, Username)

ASMB9 Firnware Update for Clear Configuration (SDR, LAN, Username)

ASUS Server Z11PP-D24 Series System

WARNING !!!

CONFIGURE BMC IP Source STATIC IP NOW !

DO YOU WANT TO CONTINUE ?

No Yes

Detect: MotherBoard - > (Z11PP-D24 Series)

Detect: KCS Interface

New BMC IP Source : Static IP

Press any key to continue . . . _

2.3.3 Configure BMC IP source DHCP

Configure BMC IP Source DHCP for Shared LAN (or DM_LAN1)

FreeDOS command prompt

Configure BMC IP Source Static IP for Shared LAN

Configure BMC IP Source DHCP IP for Shared LAN

Configure BMC IP Source Static IP for DM_LAN1

Configure BMC IP Source DHCP IP for DM_LAN1

ASMB9 Firnware Update for Preserve Configuration (SDR, LAN, Username)

ASMB9 Firnware Update for Clear Configuration (SDR, LAN, Username)

ASUS Server Z11PP-D24 Series System

WARNING !!!

CONFIGURE BMC IP Source DHCP NOW !

DO YOU WANT TO CONTINUE ?

No Yes

Detect: MotherBoard - > (Z11PP-D24 Series)

Detect: KCS Interface

New BMC IP Source : DHCP

Press any key to continue . . . _

2.4 BIOS configuration

2.4.1 Running the BIOS BMC configuration

Server Mgmt BMC network configuration

2.5 Server Mgmt menu

OS Watchdog Timer [Disabled]

OS Watchdog Timer [Enabled]

OS Wtd Timer Timeout [10 minutes]

OS Wtd Timer Policy [Reset]

Chapter 2: Hardware Information

2.5.1 System Event Log

Erase SEL [No]

When SEL is Full [Do Nothing]

E16160_ASMB9-iKVM_UM_V3.indb 8

E16160_ASMB9-iKVM_UM_V3.indb 8E16160_ASMB9-iKVM_UM_V3.indb 8 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

ASUS ASMB9-iKVM

2-9

Configure IPV4 support

DM_LAN1 / Shared LAN

Config Address Source [Previous State]

Allows you to select the IP address source type. Set the LAN channel parameters

statically or dynamically.

Configuration options: [Previous State] [Static] [DynamicBmcDhcp]

The following items are available when you set Config Address Source to [Static] .

IP Address in BMC

Allows you to set the station IP address.

Subnet Mask in BMC

Allows you to set the subnet mask. We recommend that you use the same

Subnet Mask you have specified on the operating system network for the

used network card.

Gateway IP Address

Allows you to set the Gateway IP address.

2.5.2 BMC network configuration

Allows you to set the BMC LAN parameter settings.

E16160_ASMB9-iKVM_UM_V3.indb 9

E16160_ASMB9-iKVM_UM_V3.indb 9E16160_ASMB9-iKVM_UM_V3.indb 9 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

2-10

Chapter 2: Hardware Information

Configure IPV6 support

DM_LAN1 / Shared LAN

IPV6 support [Disabled]

Allows you to enable or disable IPV6 support.

Configuration options: [Enabled] [Disabled]

The following items are available when you set IPV6 support to [Enabled].

Config Address Source [Previous State]

Allows you to select the IP address source type. Set the LAN channel

parameters statically or dynamically.

Configuration options: [Previous State] [Static] [DynamicBmcDhcp]

The following items are available when you set Config Address Source to [Static] .

Station IPV6 address

Allows you to set the station IPV6 address.

Prefix Length

Allows you to set the prefix length.

IPV6 Router1 IP Address

Allows you to set the IPV6 Router1 IP address.

2.5.3 View System Event Log

Allows you to view all the events in the BMC event logs. It will take a maximum of 15 seconds

to read all the BMC SEL records.

E16160_ASMB9-iKVM_UM_V3.indb 10

E16160_ASMB9-iKVM_UM_V3.indb 10E16160_ASMB9-iKVM_UM_V3.indb 10 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

ASUS ASMB9-iKVM

2-11

2.6 Running the ASMC8 utility

The ASMC8 utility allows you to update the ASMB9-iKVM firmware, configure the LAN settings

for the remote server, and change the user name/password in DOS environment. This utility is

available from the support CD that came with the package.

To run the ASMC8 utility:

1. Insert the support CD into the optical drive.

2. Restart the remote server then press <Del> during POST to enter the BIOS setup.

3. Go to Boot menu and set the Boot Device Priority item to [CD-ROM].

4. When finished, press <F10> to save your changes and exit the BIOS setup.

5. On reboot, select FreeDOS command prompt from the main menu then press

<Enter>.

Press any key to see next page.

6. From the C:> prompt, type ASMC8 -? then press <Enter> to display the ASMC8 Utility

Help Menu (as shown below).

FreeDOS command prompt

Configure BMC IP Source Static IP for Shared LAN

Configure BMC IP Source DHCP IP for Shared LAN

Configure BMC IP Source Static IP for DM_LAN1

Configure BMC IP Source DHCP IP for DM_LAN1

ASMB9 Firnware Update for Preserve Configuration (SDR, LAN, Username)

ASMB9 Firnware Update for Clear Configuration (SDR, LAN, Username)

ASUS Server Z11PP-D24 Series System

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

| ASUS Server Management card Utility 8.03 Help Menu |

+ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +

Usage:

ASMC8 -kcs[smic/bt/pci_smic] NetFn command data . . . .

ASMC8 -bmc_ip_source source[1:Static, 2:DHCP]

ASMC8 -bmc_ip ip_addr[10.10.10.20]

ASMC8 -bmc_mask ip_mask[255.255.255.0]

ASMC8 -bmc_gateway ip_addr[10.10.10.254]

ASMC8 -ipv6_source source[1:Static, 2:DHCP]

ASMC8 -ipv6 ipv6_addr[2001: 0db8 : 1234 : 5678 : 8769 : e1cb : aabb : ccdd]

ASMC8 -ipv6_prefix prefix_length[64]

ASMC8 -pet_ip_mac ip_addr[10.10.10.20] mac_addr[010203040506]

ASMC8 -bmc_ip_s_lan1 source[1:Static, 2:DHCP]

ASMC8 -bmc_ip_lan1 ip_addr[10.10.10.20]

ASMC8 -bmc_mask_lan1 ip_mask[255.255.255.0]

ASMC8 -bmc_g_lan1 ip_addr[10.10.10.254]

ASMC8 -ipv6_s_lan1 source[1:Static, 2:DHCP]

ASMC8 -ipv6_lan1 ip_addr[2001: 0db8 : 1234 : 5678 : 8769 : e1cb : aabb : ccdd]

ASMC8 -ipv6_prefix_lan1 prefix_length[64]

ASMC8 -pet_ip_m_lan1 ip_addr[10.10.10.20] mac_addr[010203040506]

E16160_ASMB9-iKVM_UM_V3.indb 11

E16160_ASMB9-iKVM_UM_V3.indb 11E16160_ASMB9-iKVM_UM_V3.indb 11 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

2-12

Chapter 2: Hardware Information

ASMC8 Help Menu options

Options Description

-kcs[smic/bt/pci_smic] NetFn command data.... Send IPMI command

-bmc_ip_source source[1: Static, 2: DHCP] Set the IP source

-bmc_ip [ip_addr]

(e.g., bmc_ip 10.10.10.20)

Write the BMC IP address for

dedicated LAN

-bmc_mask [ip_mask]

(e.g., bmc_mask 255.255.255.0)

Write the subnet mask for dedicated

LAN

-bmc_gateway [ip_addr]

(e.g., bmc_gateway 10.10.10.254)

Write the gateway address for

dedicated LAN

-pet_ip_mac [ip_addr] [mac_addr]

(e.g., pet_ip_mac 10.10.10.20 010203040506)

Write the PET destination IP and MAC

addresses for dedicated LAN

-bmc_ip_s_lan1 source[1: Static, 2: DHCP] Set the IP source for shared LAN

-bmc_ip_lan1 [ip_addr]

(e.g., bmc_ip 10.10.10.20)

Write the BMC IP address for shared

LAN

-bmc_mask_lan1 [ip_mask]

(e.g., bmc_mask 255.255.255.0)

Write the subnet mask for shared LAN

-bmc_g_lan1 [ip_addr]

(e.g., bmc_gateway 10.10.10.254)

Write the gateway address for shared

LAN

-pet_ip_m_lan1 [ip_addr] [mac_addr]

(e.g., pet_ip_mac 10.10.10.20 010203040506)

Write the PET destination IP and MAC

addresses for shared LAN

-adm_name new_name_string Change the administration name

-user_name new_name_string Change the user name

-adm_password new_adm_password Change the administration password

-user_password new_user_password Change the user password

-sol_baud [baud rate]

(e.g., sol_baud 57600)

Set the communication Baud rate

-bmc_info Displays the BMC and PET IP and

MAC addresses

-fru -view fru_id Displays the system FRU information

-fru -load fru_file Update system FRU data from file

-fru -save fru_id fru_file Save system FRU data to file

-sel -clear Clear system event log

E16160_ASMB9-iKVM_UM_V3.indb 12

E16160_ASMB9-iKVM_UM_V3.indb 12E16160_ASMB9-iKVM_UM_V3.indb 12 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

ASUS ASMB9-iKVM

2-13

2.6.1 Configuring the LAN controller

Before you can establish a connection to the ASMB9-iKVM board, you must configure the

LAN port for server management used by the remote server to connect to the local/central

server.

To configure the LAN port of the remote server:

1. Run the ASMC8 utility from the support CD following the instructions in the previous

section.

2. Set IP source:

a. Type ASMC8 -bmc_ip_source 1 if you want to set a static IP address.

b. Type ASMC8 -bmc_ip_source 2 if you want to get IP from DHCP server.

3. Type ASMC8 -bmc_ip xxx.xxx.xxx.xxx then press <Enter> to assign any IP

address to the remote server LAN port (if necessary). The screen displays the request

and response buffer.

Write the remote server IP address on a piece of paper for future reference.

c:\>ASMC8 -bmc_ip 10.10.10.243

Detect MotherBoard -> (Z11PP-D24 Series)

Detect KCS Interface

New BMC IP : 10.10.10.243

c:\>

When finished, the utility returns to the DOS prompt.

Make sure that the assigned IP address for both remote and local/central servers are in the

same subnet. You can use the network settings utility in your OS to check.

4. Configure your subnet mask and gateway address if necessary.

a. Type ASMC8 -bmc_mask xxx.xxx.xxx.xxx (your subnet mask encoded in

hexadecimal system)

b. Type ASMC8 -bmc_gateway xxx.xxx.xxx.xxx (your gateway address

encoded in hexadecimal system)

5. Restart the remote server, enter the BIOS setup, then boot from the hard disk drive.

6. Adjust the local/central server network settings, if necessary.

E16160_ASMB9-iKVM_UM_V3.indb 13

E16160_ASMB9-iKVM_UM_V3.indb 13E16160_ASMB9-iKVM_UM_V3.indb 13 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

2-14

Chapter 2: Hardware Information

2.6.2 Configuring the user name and password

You may change your user name and password from the ASMC8 utility.

To change the user name and password:

1. Insert the support CD into the optical drive.

2. Restart the remote server then press <Del> during POST to enter the BIOS setup.

3. Go to Boot menu and set the Boot Device Priority item to [CD-ROM].

4. When finished, press <F10> to save your changes and exit the BIOS setup.

5. On reboot, select FreeDOS command prompt from the main menu then press

<Enter>.

6. From the C:> prompt, type ASMC8 -user_name xxxxx then press <Enter> to

change the user name.

7. Type ASMC8 -user_password xxxxxxxx , then press <Enter> to change the

password.

8. Restart the remote server, enter the BIOS setup, then boot from the hard disk drive.

c:\>ASMC8 -user_name super

Detect MotherBoard -> (Z11PP-D24 Series)

Detect KCS Interface

Change User Name to super

c:\>

E16160_ASMB9-iKVM_UM_V3.indb 14

E16160_ASMB9-iKVM_UM_V3.indb 14E16160_ASMB9-iKVM_UM_V3.indb 14 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

This chapter tells you how to use the web-based user interface

that the server management board supports.

Web-based User

Interface

Chapter 3: Web-based User Interface

E16160_ASMB9-iKVM_UM_V3.indb 1

E16160_ASMB9-iKVM_UM_V3.indb 1E16160_ASMB9-iKVM_UM_V3.indb 1 1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM

1/17/2020 2:29:21 PM1/17/2020 2:29:21 PM

3-2

Chapter 3: Web-based User Interface

3.1 Web-based user interface

The web-based user interface allows you to easily monitor the remote server’s hardware

information including temperatures, fan rotations, voltages, and power. This application also

lets you instantly power on/off or reset the remote server.

To enter the Web-based user interface:

1. Enter the BIOS Setup during POST.

2. Go to the Advanced Menu > Runtime Error Logging > CPU II0 Bridge

Configuration > Launch Storage OpROM, then press <Enter>.

3. Set Launch Storage OpROM to [Enabled].

4. Go to the Server Mgmt Menu > BMC network configuration > Configuration

Address source, then press <Enter>.

5. Enter the . IP Address in BMC, Subnet Mask in BMC and Gateway Address in BMC

6. Press <F10> to save your changes and exit the BIOS Setup.

You should install JRE on remote console first before using web-based management.

You can find JRE from the folder JAVA of the ASMB9-iKVM support CD. You can also

download JRE from http://www.oracle.com/technetwork/java/javase/downloads/index.

html

E16160_ASMB9-iKVM_UM_V3.indb 2

E16160_ASMB9-iKVM_UM_V3.indb 2E16160_ASMB9-iKVM_UM_V3.indb 2 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

ASUS ASMB9-iKVM

3-3

3.1.1 Logging in the utility

1. Ensure that the LAN cable of the computer is connected to the LAN port of the remote

server.

2. Open the web browser and type in the same IP address as the one in the remote

server.

3. The below screen appears. Enter the default user name (admin) and password

(admin). Then click Login.

3.1.2 Using the utility

The web-based graphics user interface displays when you login in the utility successfully.

Click on a function from the list on the left hand side to start using its specific functions.

Function list Messages received

Content window

Notifications received

Toggle sync On/Off Reload current page

Account information

E16160_ASMB9-iKVM_UM_V3.indb 3

E16160_ASMB9-iKVM_UM_V3.indb 3E16160_ASMB9-iKVM_UM_V3.indb 3 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

3-4

Chapter 3: Web-based User Interface

3.2 Dashboard

The dashboard gives you a quick overview for all the system status, sensors, messages, and

logs. Click or hover your mouse over an item to see more details.

3.3 Sensor

The Sensor Readings page displays live readings for all the available sensors with details

like Sensor Name, Status, Current Reading and Behavior will be displayed. This page will

automatically refresh itself with data from the database. Please note that there may be some

delay when retrieving live data.

E16160_ASMB9-iKVM_UM_V3.indb 4

E16160_ASMB9-iKVM_UM_V3.indb 4E16160_ASMB9-iKVM_UM_V3.indb 4 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

ASUS ASMB9-iKVM

3-5

3.4 FRU Information

This Page displays the BMC’s FRU device information. The FRU page shows Basic

Information, Chassis Information, Board Information and Product Information of the FRU

device.

3.5 Logs & Reports

This menu contains the IPMI Event Log, System Log, Audit Log, and Video Log.

E16160_ASMB9-iKVM_UM_V3.indb 5

E16160_ASMB9-iKVM_UM_V3.indb 5E16160_ASMB9-iKVM_UM_V3.indb 5 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

3-6

Chapter 3: Web-based User Interface

3.5.1 IPMI Event Log

This page displays the list of events incurred by different sensors on this device. Click on a

record to see the details of that entry. You can click the Download Event Logs button to

download the logs.

To view the Event Log on a selected time period

1. From the field, select the time period by selecting the and Filter By Date Start Date

the from the calender.End Date

2. From the Filter By Type field, select the type of event and sensor name to view the

events of the selected event type for that sensor.

To clear all events from the list, click the Clear Event Logs button.

E16160_ASMB9-iKVM_UM_V3.indb 6

E16160_ASMB9-iKVM_UM_V3.indb 6E16160_ASMB9-iKVM_UM_V3.indb 6 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

ASUS ASMB9-iKVM

3-7

3.5.2 System Log

This page displays logs of system events for this device (if the options have been configured).

Logs have to be configured under Settings > Log Settings > Advanced Log Settings in

order to display any entries.

To view the System Log on a selected time period

1. From the field, select the time period by selecting the and Filter By Date Start Date

the from the calender.End Date

2. From the field, select the type of event to view the events of the Event Category

selected event type.

E16160_ASMB9-iKVM_UM_V3.indb 7

E16160_ASMB9-iKVM_UM_V3.indb 7E16160_ASMB9-iKVM_UM_V3.indb 7 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

3-8

Chapter 3: Web-based User Interface

3.5.3 Audit Log

This page displays logs of audit events for this device (if the options have been configured).

Logs have to be configured under Settings > Log Settings > Advanced Log Settings in

order to display any entries.

3.5.4 Video Log

This page displays logs of available recorded video files (if the options have been configured).

Logs have to be configured under Settings > Log Settings > Advanced Log Settings in

order to display any entries.

To view the Audit Log on a selected time period, from the Filter By Date field, select the time

period by selecting the Start Date and the End Date from the calender.

To view the Video Log on a selected time period, from the Filter By Date field, select the time

period by selecting the Start Date and the End Date from the calender.

E16160_ASMB9-iKVM_UM_V3.indb 8

E16160_ASMB9-iKVM_UM_V3.indb 8E16160_ASMB9-iKVM_UM_V3.indb 8 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

ASUS ASMB9-iKVM

3-9

3.6 Settings

This page allows you to configure the BMC settings. Click on an item for more options.

3.6.1 Date & Time

This page allows you to set the date and time on the BMC.

E16160_ASMB9-iKVM_UM_V3.indb 9

E16160_ASMB9-iKVM_UM_V3.indb 9E16160_ASMB9-iKVM_UM_V3.indb 9 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

3-10

Chapter 3: Web-based User Interface

3.6.2 External User Services

This page allows you to set the LDAP/E-directory Settings, Active directory Settings, and

RADIUS Settings.

LDAP/E-directory Settings

This page allows you to set the LDAP/E-directory Settings. The Lightweight Directory

Access Protocol (LDAP) is an application protocol for querying and modifying data of

directory services implemented in Internet Protocol (IP) networks. If you have an LDAP server

configured on your network, you can use it as an easy way to add, manage and authenticate

MegaRAC ® card users. This is done by passing login requests to your LDAP Server. This

means that there is no need to define an additional authentication mechanism, when using

the MegaRAC ® card. Since your existing LDAP Server keeps an authentication centralized,

you will always know who is accessing the network resources and can easily define the user

or group-based policies to control access.

Active directory Settings

This page allows you to set the Active directory Settings. An active directory does a variety

of function including the ability to provide the information on objects, helps organize these

objects for easy retrieval and access, allows access by users and administrators, and allows

the administrators to set security up for the directory.

RADIUS Settings

This page is used to enable or disable RADIUS authentication and enter the required

information to access the RADIUS server.

E16160_ASMB9-iKVM_UM_V3.indb 10

E16160_ASMB9-iKVM_UM_V3.indb 10E16160_ASMB9-iKVM_UM_V3.indb 10 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

ASUS ASMB9-iKVM

3-11

3.6.3 KVM Mouse Setting

This page allows you to set the mouse mode. The Redirection Console handles mouse

emulation from local window to remote screen using either of the three methods. Only the

Administrator has the right to configure this option.

3.6.4 Log Settings

This page allows you to set the log policy for the event log.

Log Settings Policy

This page is used to configure the log policy for the event log

Advanced Log Settings

This page allows you to set advanced settings for the event logs.

E16160_ASMB9-iKVM_UM_V3.indb 11

E16160_ASMB9-iKVM_UM_V3.indb 11E16160_ASMB9-iKVM_UM_V3.indb 11 1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM

1/17/2020 2:29:22 PM1/17/2020 2:29:22 PM

3-12

Chapter 3: Web-based User Interface

3.6.5 Media Redirection Settings

This page allows you to set the media redirection settings.

General Settings

This page allows you to enable or disable Local Media support, check or uncheck the

checkbox respectively.

VMedia Instance Settings

This page allows you to configure settings for media devices.

Remote Session

This page allows you to change the settings for the remote session.

E16160_ASMB9-iKVM_UM_V3.indb 12

E16160_ASMB9-iKVM_UM_V3.indb 12E16160_ASMB9-iKVM_UM_V3.indb 12 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-13

Network IP Settings

This page allows you to manage LAN support for the interface.

Network Bond Configuration

This page allows you to enable network bonding for network interfaces.

DNS Configuration

This page allows you to manage DNS settings of the device.

3.6.6 Network Settings

The Network Settings page allows you to configure the network settings.

E16160_ASMB9-iKVM_UM_V3.indb 13

E16160_ASMB9-iKVM_UM_V3.indb 13E16160_ASMB9-iKVM_UM_V3.indb 13 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-14

Chapter 3: Web-based User Interface

Event Filters

This page shows all configured Event filters and available slots. You can modify or add new

event filter entry on this page. By default,15 event filter entries are configured among the 40

available slots.

Alert Policies

This page shows all configured Alert policies and available slots. You can modify or add new

alert policy entry from on this page. A maximum of 60 slots are available.

LAN Destinations

This page shows all configured LAN destinations and available slots. You can modify or add

new LAN destination entry from on this page. A maximum of 15 slots are available.

3.6.7 Platform Event Filters

Platform Event Filtering (PEF) provides a mechanism for configuring the BMC to take

selected actions on event messages that it receives or has internally generated. These

actions include operations such as system power-off, system reset, as well as triggering the

generation of an alert. A PEF implementation is recommended to provide at least 16 entries

in the event filter table. A subset of these entries should be pre-configured for common

system failure events, such as over-temperature, power system failure, fan failure events, etc.

E16160_ASMB9-iKVM_UM_V3.indb 14

E16160_ASMB9-iKVM_UM_V3.indb 14E16160_ASMB9-iKVM_UM_V3.indb 14 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-15

3.6.8 Services

This page lists services running on the BMC. It shows current status and other basic

information about the services.

3.6.9 SMTP

The SMTP page allows you to configure SMTP mail server.

E16160_ASMB9-iKVM_UM_V3.indb 15

E16160_ASMB9-iKVM_UM_V3.indb 15E16160_ASMB9-iKVM_UM_V3.indb 15 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-16

Chapter 3: Web-based User Interface

3.6.10 SSL Settings

The Secure Socket Layer protocol was created by Netscape to ensure secure transactions

between web servers and browsers. The protocol uses a third party, a Certificate Authority

(CA), to identify one end or both end of the transactions.

View SSL Certificate

This page displays the basic information about the uploaded SSL certificate.

Generate SSL Certificate

This page allows you to create an SSL certificate.

Upload SSL Certificate

This page allows you to upload a certificates and private keys.

E16160_ASMB9-iKVM_UM_V3.indb 16

E16160_ASMB9-iKVM_UM_V3.indb 16E16160_ASMB9-iKVM_UM_V3.indb 16 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-17

3.6.12 User Management

The User Management page allows you to view the current list of user slots for the server.

You can add a new user and modify or delete the existing users.

3.6.11 System Firewall

This page allows you to create and manage firewalls on the BMC.

General Firewall Settings

This page allows you to create and manage existing general firewall settings.

IP Firewall Rules

This page allows you to create and manage existing firewall settings based on IP.

Port Firewall Rules

This page allows you to create and manage existing firewall settings based on ports.

E16160_ASMB9-iKVM_UM_V3.indb 17

E16160_ASMB9-iKVM_UM_V3.indb 17E16160_ASMB9-iKVM_UM_V3.indb 17 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-18

Chapter 3: Web-based User Interface

Auto Video Settings

This page allows you to configure the events that will trigger the auto video recording function

of the KVM server and display the list of available recorded video files on the BMC.

Sol Settings

The Java SOL page allows you to launch the Java SOL application.

3.6.13 Video Recording

This page allows you to customize the video recording settings.

3.6.14 Web Server Instances

This page allows you to set the number of backend web server instances that will be

launched to provide load balancing.

E16160_ASMB9-iKVM_UM_V3.indb 18

E16160_ASMB9-iKVM_UM_V3.indb 18E16160_ASMB9-iKVM_UM_V3.indb 18 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-19

3.7 Remote Control

This menu allows you to perform remote operations on the server. Click Launch KVM to start

the remote KVM.

3.7.1 Console Redirection

The remote console application, which is started using the WebGUI, allows you to control

your server's operating system remotely, using the screen, mouse, and keyboard, and to

redirect local CD/DVD, Floppy diskette and Hard disk/USB thumb drives as if they were

connected directly to the server. Click Start KVM to start the redirection session.

When launching the KVM, pop-up block should be disabled. For Internet explorer, enable

the download file options from the settings.

E16160_ASMB9-iKVM_UM_V3.indb 19

E16160_ASMB9-iKVM_UM_V3.indb 19E16160_ASMB9-iKVM_UM_V3.indb 19 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-20

Chapter 3: Web-based User Interface

Remote KVM interface

Video

1. This option is used for pausing Console Redirection.Pause Video:

2. This option is used to resume the Console Redirection when the Resume Video:

session is paused.

3. This option can be used to update the display shown in the Console Refresh Video:

Redirection window.

4. If you turn this option ON, the display will be back in the server screen.Host display:

5. This option allows you to screen capture the console redirection Capture Screen:

screen.

Mouse

1. This menu item can be used to show or hide the local mouse Show Client Cursor:

cursor on the remote client system.

2. This menu item allows you to select the mode or type of mouse support.Mouse Mode:

Options

1. Allows you to block privilege requests.Block Privilege Request:

2. Allows you to select the YUV.YUV:

3. Allows you to set the quality that ranges from 0 (Best Quality) to 7 (Worst Quality:

Quality).

E16160_ASMB9-iKVM_UM_V3.indb 20

E16160_ASMB9-iKVM_UM_V3.indb 20E16160_ASMB9-iKVM_UM_V3.indb 20 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-21

Send Keys

1. : These menu items can be used to act as holding down the corresponding Hold Down

key when in Console Redirection.

2. These menu items can be used to act as a press and release on Press and Release:

the corresponding key when in Console Redirection.

Video Record

1. : This option allows you to start recording the console redirection screen.Record Video

2. This option allows you to stop recording the console redirection Stop Recording:

screen.

3. This menu item allows you to configure the video recording settings.Record Settings:

Power

These menu items allow you to change the power settings. Click the desired option to

execute the selected action.

Active Users

This menu will display the currently active users on the server.

Help

This menu will display the help menu.

Hot Keys

These menu items allow you to make use of hot keys.

Keyboard

Keyboard Layout: This menu item allows you to select the keyboard layout.

Browse File

Click this button to add or modify a CD media, then click Start Media to start or stop the

redirection of a physical DVD/CD-ROM drive and CD image types such as iso.

E16160_ASMB9-iKVM_UM_V3.indb 21

E16160_ASMB9-iKVM_UM_V3.indb 21E16160_ASMB9-iKVM_UM_V3.indb 21 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-22

Chapter 3: Web-based User Interface

3.8 Image Redirection

This menu allows you to emulate CD/DVD/Floppy/HDD Images as media drives to host.

3.9 Power Control

The Power Control displays the current server power status and allows you to change the

current settings. Select the desired option, and then click Perform Action to execute the

selected action.

Local Media

This page allows you to select a local media to emulate to host as media through BMC.

Remote Media

This page allows you to select a remote media to emulate to host as media through BMC.

E16160_ASMB9-iKVM_UM_V3.indb 22

E16160_ASMB9-iKVM_UM_V3.indb 22E16160_ASMB9-iKVM_UM_V3.indb 22 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

3-23

3.10 Maintenance

The Maintenance menu allows you to select specific configuration items to be preserved or to

restore the default configuration for your device.

Backup Configuration

This page allows you to select specific configuration items to backup. Check the desired

items and click Download Config to download the .bak file.

Firmware Image Location

This page allows you to select the image location type.

Firmware Information

This page displays the Build Date, Build Time, and Firmware Version of the active BMC

image.

Firmware Update

This page allows you to update the firmware of the device remotely.

Preserve Configuration

This page allows you to select specific configuration items to be preserved in while performing

the Restore Configuration.

Restore Configuration

This page allows you to select and upload a .bak file to restore the configuration settings.

E16160_ASMB9-iKVM_UM_V3.indb 23

E16160_ASMB9-iKVM_UM_V3.indb 23E16160_ASMB9-iKVM_UM_V3.indb 23 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

3-24

Chapter 3: Web-based User Interface

Restore Factory Defaults

This page allows you to select configuration items that will be preserved while all the other

configuration items will be restored to their default values. If none are selected, all the

configuration items will be restored to their default values, essentially restoring the device

configuration to its factory defaults.

System Administrator

This page allows you to change the System Administrator settings.

E16160_ASMB9-iKVM_UM_V3.indb 24

E16160_ASMB9-iKVM_UM_V3.indb 24E16160_ASMB9-iKVM_UM_V3.indb 24 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

This chapter provides you with information on the Redfish APIs

supported.

Redfish Technology Pack

E16160_ASMB9-iKVM_UM_V3.indb 1

E16160_ASMB9-iKVM_UM_V3.indb 1E16160_ASMB9-iKVM_UM_V3.indb 1 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

4-2

Chapter 4: Redfish Technology Pack

4.1 Redfish introduction

Redfish is a web based management protocol software solution developed to be fully

compliant with DMTF Redfish specification, and allows users to browse physical resources

at the chassis and system level through an intuitive web-based user interface. It is built upon

Representational State Transfer (REST) which is itself based on HTTP 1.1 protocol. Redfish

improves the scalability and help customers to integrate with existing tools.

Redfish is a hypermedia API with a small set of defined URI’s. This chapter provides the

API list supported by the Redfish Server and the HTTP methods for each URL in addition

to a detailed explanation of the request and JSON response properties. As Redfish is built

on OData specification, it discusses the OData properties and the OData identifier for the

resources.

Redfish provides information categorized under specific resource end point. The redfish

clients allows to utilize the end points using following HTTP methods:

• GET

• POST

• PATCH

• PUT

• DELETE

Not all end-points support all these operations. When not supported it must send back 405

HTTP Status. Such details on the operations are provided by the Redfish JSON Schema.

Redfish Server follows DSP0266 1.1.0 Specification and Redfish Schema 2016.3 .

E16160_ASMB9-iKVM_UM_V3.indb 2

E16160_ASMB9-iKVM_UM_V3.indb 2E16160_ASMB9-iKVM_UM_V3.indb 2 1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM

1/17/2020 2:29:23 PM1/17/2020 2:29:23 PM

ASUS ASMB9-iKVM

4-3

4.2 Redfish API

4.2.1 Redfish API List

The following Redfish defined URI’s listed in the table below are supported by the Redfish

Service:

Table 1 Redfish API List

Resource Resource URI Redfish Schema

Service Root /redfish/v1 ServiceRoot.v1_1_1.ServiceRoot

Computer System Collection /redfish/v1/Systems ComputerSystemCollection.

ComputerSystemCollection

Computer System /redfish/v1/Systems/{{system_

instance}}

ComputerSystem.v1_3_0.

ComputerSystem

Memory Collection /redfish/v1/Systems/Self/Memory MemoryCollection.MemoryCollection

Memory /redfish/v1/Memory/{{Memory_

instance}}

Memory.v1_1_0.Memory

Processor Collection /redfish/v1/Systems/{{system_

instance}}/Processors

ProcessorCollection.

ProcessorCollection

Processor /redfish/v1/Systems/{{system_

instance}}/Processors/{{system_

processor_instance}}

Processor.v1_0_3.Processor

Ethernet Interface Collection /redfish/v1/Managers/{{manager_

instance}}/EthernetInterfaces

EthernetInterfaceCollection.

EthernetInterfaceCollection

Ethernet interface /redfish/v1/Managers/{{manager_

instance}}/EthernetInterfaces/

EthernetInterface.v1_2_0.

EthernetInterface

Simple Storage Collection /redfish/v1/Systems/{{system_

instance}}/SimpleStorage

SimpleStorageCollection.

SimpleStorageCollection

Simple Storage /redfish/v1/Systems/{{system_

instance}}/SimpleStorage/{{system_

simplestorage_instance}}

SimpleStorage.v1_1_1.

SimpleStorage

LogServiceCollection /redfish/v1/Systems/{{system_

instance}}/LogServices

/redfish/v1/Managers/{{manager_

instance}}/LogServices

/redfish/v1/Chassis{{chassis_

instance}}/LogServices

LogServiceCollection.

LogServiceCollection

Log Service /redfish/v1/Systems/{{system_

instance}}/LogServices/{{system_

log_instance}}

/redfish/v1/Managers/{{manager_

instance}}/LogServices/{{manager_

log_instance}}

LogService.v1_0_3.LogService

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 3

E16160_ASMB9-iKVM_UM_V3.indb 3E16160_ASMB9-iKVM_UM_V3.indb 3 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

4-4

Chapter 4: Redfish Technology Pack

Resource Resource URI Redfish Schema

LogEntry Collection /redfish/v1/Systems/{{system_

instance}}/LogServices/{{system_

log_instance}}/Entries

/redfish/v1/Managers/{{manager_

instance}}/LogServices/{{manager_

log_instance}}/Entries

/redfish/v1/Chassis{{chassis_

instance}}/LogServices/{{chassis_

log_instance}}/Entries

LogEntryCollection.

LogEntryCollection

Log Entry /redfish/v1/Systems/{{system_

instance}}/LogServices/{{system_

log_instance}}/Entries/{{system_

logentry_instance}}

/redfish/v1/Managers/{{manager_

instance}}/LogServices/{{manager_

log_instance}}/Entries/{{manager_

logentry_instance}}

/redfish/v1/Chassis{{chassis_

instance}}/LogServices/{{chassis_

log_instance}}/Entries/{{chassis_

logentry_instance}}

LogEntry.v1_1_1.LogEntry

VLANNetwork

InterfaceCollection

/redfish/v1/Systems/{{system_

instance}}/EthernetInterfaces/

{{system_ethifc_instance}}/VLANs

VLanNetworkInterfaceCollection.

VLanNetworkInterfaceCollection

VLAN Network Interface /redfish/v1/Systems/{{system_

instance}}/EthernetInterfaces/

{{system_ethifc_instance}}/VLANs/

VLanNetworkInterface.v1_0_3.

VLanNetworkInterface

ChassisCollection /redfish/v1/Chassis ChassisCollection.ChassisCollection

Chassis /redfish/v1/Chassis/{{chassis_

instance}}

Chassis.v1_4_0.Chassis

Power /redfish/v1/Chassis/{{chassis_

instance}}/Power

Power.v1_2_1.Power

Thermal /redfish/v1/Chassis/{{chassis_

instance}}/Thermal

Thermal.v1_2_0.Thermal

ManagerCollection /redfish/v1/Managers ManagerCollection.

ManagerCollection"

Manager /redfish/v1/Managers/Self/

NetworkProtocol

Manager.v1_3_0.Manager

ManagersNetworkProtocol /redfish/v1/Managers/Self/

NetworkProtocol

ManagerNetworkProtocol.v1_1_0.

ManagerNetworkProtocol

SerialInterfaces Collection /redfish/v1/Managers/{{manager_

instance}}/SerialInterfaces

SerialInterfaceCollection.

SerialInterfaceCollection

SerialInterfaces /redfish/v1/Managers/{{manager_

instance}}/SerialInterfaces/

SerialInterface.v1_0_3.SerialInterface

VirtualMedia Collection /redfish/v1/Managers/{{manager_

instance}}/VirtualMedia

VirtualMediaCollection.

VirtualMediaCollection

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 4

E16160_ASMB9-iKVM_UM_V3.indb 4E16160_ASMB9-iKVM_UM_V3.indb 4 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

ASUS ASMB9-iKVM

4-5

Resource Resource URI Redfish Schema

AccountService /redfish/v1/AccountService AccountService.v1_1_0.

AccountService

Manager Account Collection /redfish/v1/AccountService/

Accounts

ManagerAccountCollection.

ManagerAccountCollection

Manager Account /redfish/v1/AccountService/

Accounts/{{account_instance}}

ManagerAccount.v1_0_3.

ManagerAccount

Role Collection /redfish/v1/AccountService/Roles RoleCollection.RoleCollection

Role /redfish/v1/AccountService/Roles/

Role.v1_0_2.Role

EventService redfish/v1/EventService EventService.v1_0_3.EventService

TaskService /redfish/v1/TasksService TaskService.v1_0_3.TaskService

NetworkAdapter Collection /redfish/v1/Chassis/Self/

NetworkAdapters

NetworkAdapterCollection.

NetworkAdapterCollection

NetworkAdapter /redfish/v1/Chassis/Self/

NetworkAdapters/{{NetwrokAdapter_

instance}}

NetworkAdapter.v1_0_0.

NetworkAdapter

Storage Collection /redfish/v1/Systems/Self/Storage StorageCollection.StorageCollection

SecureBoot /redfish/v1/Systems/Self/

SecureBoot

SecureBoot.v1_0_1.SecureBoot

AMI OEM Extensions

Resource Resource URI Redfish Schema

Configurations /redfish/v1/configurations Configurations.v1_0_0.Configurations

AccountService

Configurations

/redfish/v1/AccountService/

Configurations

AccountServiceConfigurations.

v1_0_0.

AccountServiceConfigurations

E16160_ASMB9-iKVM_UM_V3.indb 5

E16160_ASMB9-iKVM_UM_V3.indb 5E16160_ASMB9-iKVM_UM_V3.indb 5 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

4-6

Chapter 4: Redfish Technology Pack

4.2.2 Redfish API defnition

A. OData Support

https://{{ip}}/redfish/v1/Managers/Self/HostInterfaces/

Redfish API supports Odata v4.0 as it is defined in Redfish specification. All resources within

this REST API are identified by a unique identifier property named @odata.id. Resource

Identifiers shall be represented in JSON payloads as URI paths relative to the Redfish

Schema portion of the URI. That is, they shall always start with /redfish/ . The resource

identifier is the canonical URL for the resource and can be used to retrieve or edit the

resource, as appropriate. OData Properties that are part of the JSON response for every

Redfish Resource is defined under 4.3.1 ODATA properties .

B. Protocol version

The protocol version is separate from the version of the resources or the version of the

Redfish Schema supported by them.

The root URI for this version of the Redfish protocol shall be /redfish/v1/ .

While the major version of the protocol is represented in the URI, the major version, minor

version and errata version of the protocol are represented in the Version property of the

Service Root resource, as defined in the Redfish Schema for that resource. The protocol

version is a string of the form:

Major Version, Minor Version, Errata

Major Version: integer: something in the class changed in a backward incompatible way.

Minor Version: integer: a minor update. New functionality may have been added but

nothing removed. Compatibility will be preserved with previous

minor versions.

Errata: integer: something in the prior version was broken and needed to be fixed.

Any resource discovered through links found by accessing the root service or any service or

resource referenced using references from the root service shall conform to the same version

of the protocol supported by the root service.

C. URI Rules

Redfish Service supports a small set of defined default URIs without authentication. They are:

Table 2 URIs without authentication

URI Description

/redfish URI used to return the version

/redfish/v1/ URI for the Redfish Service Root

/redfish/v1/odata URI for OData Service Document

/redfish/v1/$metadata URI for metadata document

E16160_ASMB9-iKVM_UM_V3.indb 6

E16160_ASMB9-iKVM_UM_V3.indb 6E16160_ASMB9-iKVM_UM_V3.indb 6 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

ASUS ASMB9-iKVM

4-7

The following Redfish URI is redirected to the Associated URI as given below:

Table 3 Associated URI

URI Associated Redfish-Defined URI

/redfish/v1/ /redfish/v1/

The other defined and relative Redfish URIs are accessed using basic Authentication. Those

URIs are explained in 4.3 Redfish Resources .

• Redfish URI Rules for Redirection

All URI’s given in Redfish API List in Table 1 with a trailing slash will be redirected to

the same URI without a trailing slash and will send the response status and body as

the original URI’s in Table 1 .

For example: “ /redfish/v1/Systems/{{system_instance}}/ ” with a trailing

slash will be redirected to “ /redfish/v1/Systems/{{system_instance}} ” and

both will display the same response.

4.2.3 Requests

This section describes the requests that can be sent to Redfish services

A. Read Requests (GET)

The GET method is used to retrieve a representation of a resource. That representation can

either be a single resource or a collection.

• Service Root Request

The root URL for Redfish version 1 services shall be “ /redfish/v1/ ”. The root URL

for the service returns a Service Root resource as defined by this specification.

• Metadata Document Request

Redfish services shall expose a metadata document describing the service at the “ /

redfish/v1/$metadata ” resource. The Services shall not require authentication in

order to retrieve the metadata document.

• OData Service Document Request

Redfish services shall expose an OData Service Document, at the /redfish/v1/

odata resource. This service document provides a standard format for enumerating

the resources. Services shall not require authentication in order to retrieve the service

document.

• Resource Retrieval Requests

Clients request resources by issuing GET requests to the URI for the individual

resource or resource collection. The URI for a resource or resource collection may be

obtained from a resource identifier property returned in a previous request

E16160_ASMB9-iKVM_UM_V3.indb 7

E16160_ASMB9-iKVM_UM_V3.indb 7E16160_ASMB9-iKVM_UM_V3.indb 7 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

4-8

• HEAD

The HEAD method differs from the GET method in that it MUST NOT return message

body information. However, all of the same meta information and status codes in the

HTTP headers will be returned as though a GET method were processed, including

authorization checks. Services may support the HEAD method in order to return meta

information in the form of HTTP response headers. Services may support the HEAD

method in order to verify link validity. Services may support the HEAD method in order

to verify resource accessibility. Services shall not support any other use of the HEAD

method. The HEAD method shall be idempotent in the absence of outside changes to

the resource.

B. Data Modification Requests

Clients create, modify, and delete resources by issuing the appropriate Create, Update,

Replace or Delete operation, or by invoking an Action on the resource.

The maximum request size set for request body in Redfish is 256KB.

• Update (PATCH)

The PATCH method is the preferred method used to perform updates on pre-existing

resources. Changes to the resource are sent in the request body. Properties not

specified in the request body are not directly changed by the PATCH request. The

response is either empty or a representation of the resource after the update was done.

The implementation may reject the update operation on certain fields based on its own

policies and, if so, shall not apply any of the update requested.

• Replace (PUT)

The PUT method is used to completely replace a resource. Properties omitted from the

request body are reset to their default value.

• Create (POST)

The POST method is used to create a new resource. The POST request is submitted

to the resource collection in which the new resource is to belong. Submitting a POST

request to a resource representing a collection is equivalent to submitting the same

request to the Members property of that resource.

• Delete (DELETE)

The DELETE method is used to remove a resource. Services shall support the

DELETE method for resources that can be deleted.

• Actions (POST)

The POST method is used to initiate operations on the object (such as Actions).

Services shall support the POST method for sending actions. The POST operation may

not be idempotent.

4.2.4 Responses

A. Response Headers

Redfish 1.0.4 Specification

B. Redfish error response

Table 4 Error Code Response

Attribute Description

• Common Error Status Codes

- 404 Not Found

- 400 Bad Request

- 405 Method Not Found

C. Status Codes

Redfish 1.0.4

Specification

4.3 Redfish Resources

Request URI’s and JSON Responses allowable HTTP

methods Redfish Resources 4.3.4 Service

Root 4.3.1 ODATA properties

4.3.2 User Configurable Properties

4.3.3 Resource

4.3.4 Service Root

Configurable Keys How to Add OEM extensions (v1.1)

4.3.1 ODATA properties

{

“@odata.context”: “/redfish/v1/$metadata#ServiceRoot”,

“@odata.etag”: “W/\”1488550735\””,

“@odata.id”: “/redfish/v1/”,

“@odata.type”: “#ServiceRoot.v1_0_2.ServiceRoot”

}

Table 5 OData Attributes

Name Type ReadOnly Description

Name Type ReadOnly Desceiption

Redfish Specification 1.1.0

6.1.5 Etags

4.3.2 User Configurable Properties

MegaRAC Redfish - How to Add OEM extensions (v1.1)

MegaRAC Redfish - How to Add OEM

extensions (v1.1)

4.3.3 Resource

Table 6 Resource Type Definitions

Name Type ReadOnly Description

Table 7 Resource - Enum Types

State

Enum Description

Identifier Object True

Name Type ReadOnly Description

Location Object True

Name Type ReadOnly Description

Reset

Enum Description

Health / HealthRollup

IndicatorLED

Table 8 Resource Complex Types

Links

Property Name Type Description

Status

Property Name Type ReadOnly Description

Table 7 Resource - Enum Types

Table 9 Resource.v1_1_0 schema properties

Identifier

Property Name Type ReadOnly Description

Enum Description

Identifier

Property Name Type ReadOnly Description

Enum Description

Location

Property Name Type ReadOnly Description

Table 10 Enum Types – Indicator LED

Member Name Description

4.3.4 Service Root

/redfish/v1/

A. GET

• Request

https://{{ip}}/redfish/v1/

Content-Type: application/json

• Response

Table 11 Service Root Properties

Name Type ReadOnly Description

4.3.1 ODATA properties

4.3.3 Resource

How to Add

OEM extensions (v1.1)

Id(M) 4.3.3 Resource

Name(M) 4.3.3 Resource

4.3.3 Resource

E16160_ASMB9-iKVM_UM_V3.indb 17

E16160_ASMB9-iKVM_UM_V3.indb 17E16160_ASMB9-iKVM_UM_V3.indb 17 1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM

1/17/2020 2:29:24 PM1/17/2020 2:29:24 PM

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

PropertyName Type ReadOnly Description

4.3.3

Resource

How

to Add OEM

extensions (v1.1)

4.3.5 Computer System Collection

A. GET

• Request

https://{{ip}}/redfish/v1/Systems

Content-Type: application/json

• Response

Table 12 ComputerSystem Properties

E16160_ASMB9-iKVM_UM_V3.indb 18

E16160_ASMB9-iKVM_UM_V3.indb 18E16160_ASMB9-iKVM_UM_V3.indb 18 1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM1/17/2020 2:29:25 PM

ASUS ASMB9-iKVM

4-19

4.3.6 Computer System

A computer system represents a machine (physical or virtual) and the local resources such

as memory, CPU and other devices that can be accessed from that machine. Information on

these resources or sub systems are also linked to this resource. This resource shall be used

to represent resources that represent a computing system in the Redfish specification.

The following BIOS module labels should be present for populating smbios information in

BMC and thereby to view Memory and Processor instance information:

OemPublishTables

SS: AptioV;$/AptioV/Source/Modules/OemPublishTables;OemPublishTables_02

REST

SS: AptioV;$/AptioV/Source/Modules/RestSmBios;RestSmBios_01

SS: AptioV;$/AptioV/Source/Modules/RestIpmi;RestIpmi_04

SS:AptioV;$/AptioV/Source/Interfaces/AmiDataProcessingPkg;AmiDataProcessingPkg_03

Please contact with your sales representative for further information on this AMI BIOS

Package distribution.

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}

Content-Type: application/json

Systems instance in BMC represents a single System and it’s id represented as Self.

For Example: https://{{ip}}/redfish/v1/Systems/Self

• Response

The response of the request will be in JSON format. The properties are mentioned in

the following table.

Table 12 ComputerSystem Properties

Name Type ReadOnly Description

@odata.context String True Refer to section .4.3.1 ODATA properties

@odata.id String True Refer to section .4.3.1 ODATA properties

@odata.type String True Refer to section .4.3.1 ODATA properties

@odata.etag String True Refer to section .4.3.1 ODATA properties

Oem Object Refer to Resource Complex Types under section .4.3.3 Resource

This property will be a part of JSON response only if an

OEM property is implemented according to “ How to Add

OEM extensions (v1.1) ” document.

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 19

E16160_ASMB9-iKVM_UM_V3.indb 19E16160_ASMB9-iKVM_UM_V3.indb 19 1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM1/17/2020 2:29:25 PM

4-20

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

Id(M) String True Resource Identifier.

Name(M) String True Name of the Resource.

Description String True Provides description of the resource. Refer to section .4.3.3 Resource

SystemType String True An enumeration that indicates the kind of system that this resource

represents.

Enum Description

Physical A computer system.

Virtual A virtual machine instance running on this

system.

OS A computer system.

PhysicallyPartitioned A hardware-based partition of a computer

system.

VirtuallyPartitioned A virtual or software-based partition of a

computer system.

Links Object True The Links property, as described by the Redfish Specification, shall

contain references to resources that are related to, but not contained by

(subordinate to), this resource.

Name Type ReadOnly Description

Oem Object - OEM extension object

Refer to Resource Complex

Types under section 4.3.3

Resource.

It will be present in

response if there is

an OEM property

implemented

according to “ How

to Add OEM

extensions (v1.1) ”

document.

Chassis(N) Array True An array of references to the

chassis in which this system is

contained

ManagedBy(N) Array True An array of references to the

Managers responsible for this

system.

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 20

E16160_ASMB9-iKVM_UM_V3.indb 20E16160_ASMB9-iKVM_UM_V3.indb 20 1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM1/17/2020 2:29:25 PM

ASUS ASMB9-iKVM

4-21

Name Type ReadOnly Description

PoweredBy(N) Array True An array of ID[s] of resources

that power this computer

system. Normally the ID will be

a chassis or a specific set of

power Supplies.

Platform specific

porting needed.

Refer to Platform

Specific Properties

section in OEM

Extension doc.

CooledBy(N) Array True An array of ID[s] of resources

that cool this computer system.

Normally the ID will be a chassis

or a specific set of fans.

Platform specific

porting needed.

Refer to Platform

Specific Properties

section in OEM

Extension doc.

Endpoints(N) Array True An array of references to the

endpoints that connect to this

system.

These will be

available only as a

part of FPX Product.

AssetTag String False The user definable tag that can be used to track this computer system

for inventory or other client purposes.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is).

Manufacturer String True Manufacturer or OEM of this system.

• This property will be populated if SMBIOS dump is

present in BMC.

• This can be populated by Host Interface, (Extra Bios

Support is needed, now is).

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 21

E16160_ASMB9-iKVM_UM_V3.indb 21E16160_ASMB9-iKVM_UM_V3.indb 21 1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM1/17/2020 2:29:25 PM

Name Type ReadOnly Description

How to Add OEM

extensions (v1.1)

How to Add OEM extensions (v1.1)

Name Type ReadOnly Description

Enum Description

Table 13 ComputerSystem – Boot

Properties

4-24

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

BiosVersion String True The version of the system BIOS or primary system firmware.

This property will be populated if SMBIOS dump is present

in BMC.

ProcessorSummary - - This object describes the central processors of the system in general

detail.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is).

Name Type ReadOnly Description

Count Number True The number of processors in

the system.

Model String True The processor model for

the primary or majority of

processors in this system.

Status Object True Refer to Resource Complex

Types under section 4.3.3

Resource.

Northbound only

support

MemorySummary - - This object describes the central memory of the system in general

detail.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is).

Name Type ReadOnly Description

TotalSystem

MemoryGiB

Number True The total installed, operating

system-accessible memory

(RAM), measured in GiB.

Status Object True Refer to Resource Complex

Types under section 4.3.3

Resource.

Northbound only

support

Memory

Mirroring

String True The ability and type of memory

mirroring supported by this

system. It can take any of the

following values:- System,

DIMM, Hybrid, None.

Northbound only

support

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 24

E16160_ASMB9-iKVM_UM_V3.indb 24E16160_ASMB9-iKVM_UM_V3.indb 24 1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM

1/17/2020 2:29:25 PM1/17/2020 2:29:25 PM

ASUS ASMB9-iKVM

4-25

Name Type ReadOnly Description

Actions Object True Computer System allows the user to perform Reset Action and it’s

allowable values are as given in section . Please refer 4.3.3 Resource

to Reset enum type under Resource. It can also contains an OEM

Object under OEM attribute within this Action.

EthernetInterfaces(N) Object True A reference to the collection of Ethernet interfaces associated with

this system.

SimpleStorage(N) Object True A reference to the collection of storage devices associated with

this system.

LogServices(N) Object True A reference to the collection of Log Services associated with this

system.

Status Object True Please refer to section 4.3.3 Resource for Resource.Status.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is)

TrustedModules Array True This object describes the array of Trusted Modules in the

system.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is)

SecureBoot(N) Object True A reference to the UEFI SecureBoot resource associated with this

system.

This can be populated by Host Interface, (Extra Bios

Support is needed, now is)

Bios(N) Object True A reference to the BIOS settings associated with this system.

This link will be populated only if corresponding BIOS

module is present.

Memory(N) Object True A reference to the collection of Memory associated with this system.

This link will be populated if memory information is

populated from SMBIOS dump.

Storage(N) Object True A reference to the collection of storage devices associated with this

system.

Northbound API is supported but still requires host

interface and host agent support from host agent and in-

band communication channel and platform specific porting

needed.

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 25

E16160_ASMB9-iKVM_UM_V3.indb 25E16160_ASMB9-iKVM_UM_V3.indb 25 1/17/2020 2:29:26 PM

1/17/2020 2:29:26 PM

1/17/2020 2:29:26 PM1/17/2020 2:29:26 PM

4-26

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

NetworkInterfaces(N) Object True A reference to the collection of Network Interfaces associated with this

system.

This link will be populated only if corresponding BIOS

module is present.

HostingRoles Array True The hosting roles that this computer system supports.

Enum Description

ApplicationServer The system hosts functionality that supports general

purpose applications.

StorageServer The system hosts functionality that supports the

system acting as a storage server.

Switch The system hosts functionality that supports the

system acting as a switch.

HostedServices Object True The services that this computer system supports.

• At present only OEM property is supported under it. Refer

to Resource Complex Types under 4.3.3 Resource .

• It will be present in response if there is an OEM

property implemented according to “ How to Add OEM

extensions (v1.1) ” document.

PCIeDevices(N) Object True A reference to a collection of PCIe Devices used by this computer

system.

Links will be available only when Host Interface feature is

enabled and the corresponding AMI BIOS Image is used.

PCIeFunctions(N) Object True A reference to a collection of PCIe Functions used by this computer

system.

Links will be available only when Host Interface feature is

enabled and the corresponding AMI BIOS Image is used.

E16160_ASMB9-iKVM_UM_V3.indb 26

E16160_ASMB9-iKVM_UM_V3.indb 26E16160_ASMB9-iKVM_UM_V3.indb 26 1/17/2020 2:29:26 PM

1/17/2020 2:29:26 PM

1/17/2020 2:29:26 PM1/17/2020 2:29:26 PM

4-44

Chapter 4: Redfish Technology Pack

4.3.12 EthernetInterface

A. Systems

This resource shall be used to represent host side NIC resources. This requires host agent

support from OS and in-band communication channel.

• In BMC, Redfish Inventory population for this API can be achieved by one of

the 2 methods and is available as part of Build Time PRJ Selection “Inventory

Configuration”:

- HostInterface

- SMBIOS

Northbound API is supported but still requires host agent support from host agent and

in-band communication channel and platform specific porting needed.

• Host Agent should be running in Host and should be capable to send this information

through a channel created between Host & BMC like IPMI/KCS/USB interface etc or

by some other proprietary protocol.

• Sync agent OEM extension should be written in which this data should be written onto

redis db. Customer can refer to section 1.3 in “How to add OEM Extensions” for it.

• Key to populate on redisdb:

SET Redfish:Systems:Self:EthernetInterfaces:{{Interface1}}:

Example: SET Redfish:Systems:Self:EthernetInterfaces:

eth0:ResourceExists:Name eth0

B. Managers

This resource shall be used to represent the NIC resources in the manager.

• GET - EthernetInterface Instance

- Request for EthernetInterface Instance

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

EthernetInterfaces/{{manager_ethifc_instance}}

Content-Type: application/json

- Response

The response of the request will be in JSON format. The properties are mentioned in

the following table.

Manager Ethernet Interface typically supports at max one VLAN per interface for a single

BMC.

E16160_ASMB9-iKVM_UM_V3.indb 44

E16160_ASMB9-iKVM_UM_V3.indb 44E16160_ASMB9-iKVM_UM_V3.indb 44 1/17/2020 2:29:27 PM

1/17/2020 2:29:27 PM

1/17/2020 2:29:27 PM1/17/2020 2:29:27 PM

ASUS ASMB9-iKVM

4-45

Table 19 Ethernet Interface Properties

Name Type ReadOnly Description

@odata.context String True Refer to section .4.3.1 ODATA properties

@odata.id String True Refer to section .4.3.1 ODATA properties

@odata.type String True Refer to section .4.3.1 ODATA properties

@odata.etag String True Refer to section .4.3.1 ODATA properties

Oem Object Refer to Resource Complex Types under section .4.3.3 Resource

This property will be a part of JSON response only if an

OEM property is implemented according to “ How to Add

OEM extensions (v1.1) ” document.

Id(M) String True Resource Identifier.

Name(M) String True Name of the Resource.

Description String True Provides description of the resource. Refer to section .4.3.3 Resource

UefiDevicePath String True The UEFI device path for this interface (port).

Platform specific porting needed. Please refer to Manager

EthernetInterface under Platform specific Properties in “ How

to Add OEM extensions (v1.1) ” document.

Status Object True Refer to section for Status under Resource Complex 4.3.3 Resource

Types.

InterfaceEnabled Boolean False This indicates whether this interface is enabled.

Permanent

MACAddress

String True The value of this property shall be the Permanent MAC Address of

this interface (port). This value is typically programmed during the

manufacturing time. This address is not assignable.

MACAddress String True The value of this property shall be the effective current MAC Address of

this interface. If an assignable MAC address is not supported, this is a

read only alias of the PermanentMACAddress.

Even though the ReadOnly attribute in Redfish schema for

managers is specified as “False”, In Redfish API, patching

MACAddress is not allowed. Changing MACAddress will

change the IP address and if user is using redfish in remote

with no access to host/BMC, it will be an issue in obtaining

new IP address and also change in MACAddress could

result in mac address collision if there is a device on the

local network with the same mac address.

SpeedMbps Number False The current link speed of the interface in Mbps.

Platform specific porting needed. Please refer to Manager

EthernetInterface under Platform specific Properties in “ How

to Add OEM extensions (v1.1) ” document.

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 45

E16160_ASMB9-iKVM_UM_V3.indb 45E16160_ASMB9-iKVM_UM_V3.indb 45 1/17/2020 2:29:27 PM

1/17/2020 2:29:27 PM

1/17/2020 2:29:27 PM1/17/2020 2:29:27 PM

4-46

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

AutoNeg Boolean False The value of this property shall be true if auto negotiation of speed and

duplex is enabled on this interface and false if it is disabled.

FullDuplex Boolean False The value of this property shall represent the duplex status of the

Ethernet connection on this interface.

Platform specific porting needed. Please refer to Manager

EthernetInterface under Platform specific Properties in “ How

to Add OEM extensions (v1.1) ” document.

MTUSize Number False The value of this property shall be the size in bytes of largest Protocol

Data Unit (PDU) that can be passed in an Ethernet (MAC) frame on this

interface.

• Platform specific porting needed. Please refer to

Manager EthernetInterface under Platform specific

Properties in “ How to Add OEM extensions (v1.1) ”

document.

• MTU (Maximum Transmission Unit)

HostName String False DNS Hostname without any domain information.

FQDN String False This is the complete, fully qualified domain name obtained by DNS for

this interface.

MaxIPv6Static

Addresses

Number True This indicates the number of array items supported by

Ipv6StaticAddresses.

VLAN Object False If this Network Interface supports more than one VLAN, this property will

not be present and the client should look for VLANs collection in the link

section of this resource.

Name Type ReadOnly Description

VLANEnable Boolean False This indicates if this VLAN is

enabled.

VLANId Number False This indicates the VLAN identifier

for this VLAN. Num value : 0 and

Maximum value: 4095.

Ipv4Addresses Array of

Objects

False This array of objects represents all of the Ipv4 static

addresses to be assigned on this interface. Refer to Table 20

Ipv4AddressesProperties.

Ipv6Addresses Array of

Objects

False This array of objects enumerates all of the currently

assigned Ipv6 addresses on this interface. Refer to Table 21

Ipv6AddressesProperties.

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 46

E16160_ASMB9-iKVM_UM_V3.indb 46E16160_ASMB9-iKVM_UM_V3.indb 46 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

ASUS ASMB9-iKVM

4-47

Name Type ReadOnly Description

Ipv6StaticAddresses Array of

Objects

False This array of objects represents all of the Ipv6 static addresses to be

assigned on this interface.

Platform specific porting needed. Please refer to Manager

EthernetInterface under Platform specific Properties in “ How

to Add OEM extensions (v1.1) ” document.

Name Type ReadOnly Description

Oem Object False Refer to section 4.3.3 Resource

for Resource.Oem.

Address String False A static Ipv6 address that is

currently assigned on a network

interface.

PrefixLength True Provides the Ipv6 network prefix Number

length in bits for this address.

Min:1,Max:128.

Due to constraint

of schema

IPAddresses.v1_0_0.

json, PrefixLength =

0 will be reported as

ValidationError.

Ipv6DefaultGateway String True This is the Ipv6 default gateway address that is currently in use on this

interface.

NameServers Array

[Items

of type

String]

True This represents DNS name servers that are currently in use on this

interface.

VLANs(N) Object True This is a reference to a collection of VLANs and is only used if the

interface supports more than one VLANs.VlanInterfaceCollection.

Platform specific porting needed.

(continued on the next page)

Table 20 Ipv4AddressesProperties

Name Type ReadOnly Description

Address String False This is the Ipv4 address. If DHCPv4 is enabled on the interface, this

property becomes read-only.

SubnetMask Object False This is the Ipv4 address. If DHCPv4 is enabled on the interface, this

property becomes read-only.

String with pattern “ ”^(?:[0-9]{1,3}\\.){3}[0-9]{1,3}$

E16160_ASMB9-iKVM_UM_V3.indb 47

E16160_ASMB9-iKVM_UM_V3.indb 47E16160_ASMB9-iKVM_UM_V3.indb 47 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

4-48

Chapter 4: Redfish Technology Pack

Name Type ReadOnly Description

AddressOrigin String True This is the Ipv4 gateway for this address.

Enum Description

Static A static address as configured by the user.

DHCP Address is provided by a DHCPv4 service

BOOTP Address is provided by a BOOTP service.

Ipv4LinkLocal Address is valid only for this network segment

(link).

Gateway String False This is the Ipv4 default gateway address for this interface. If DHCPv4

is enabled on the interface and is configured to set the Ipv4 default

gateway address, this property becomes read-only.

Table 21 Ipv6AddressesProperties

Name Type ReadOnly Description

Address String False A static Ipv6 address that is currently assigned on a network interface.

PrefixLength Number True Provides the Ipv6 network prefix length in bits for this address.

Min:1,Max:128.

Due to constraint of schema IPAddresses.v1_0_0.json,

PrefixLength = 0 will be reported as ValidationError.

AddressOrigin String True This is the Ipv6 address origin for this interface.

Enum Description

Static A static address as configured by the user.

DHCPv6 Address is provided by a DHCPv6 service.

LinkLocal Address is valid only for this network segment

(link).

SLAAC Address is provided by a Stateless Address

AutoConfiguration (SLAAC) service.

AddressState String True The current state of this address as defined in RFC 4862.

Enum Description

Preferred This address is currently within both it’s valid

and preferred lifetimes as defined in RFC

4862.

Deprecated This address is currently within it’s valid

lifetime, but is now outside of it’s preferred

lifetime as defined in RFC 4862.

LinkLocal Address is valid only for this network segment

(link).

SLAAC Address is provided by a Stateless Address

AutoConfiguration (SLAAC) service.

E16160_ASMB9-iKVM_UM_V3.indb 48

E16160_ASMB9-iKVM_UM_V3.indb 48E16160_ASMB9-iKVM_UM_V3.indb 48 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

ASUS ASMB9-iKVM

4-49

• PATCH

- Request

PATCH https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

EthernetInterfaces/{{manager_ethifc_instance}}

Content-Type: application/json

Request Body

Please refer to the properties that are patchable in Table 19 Ethernet Interface

Properties for which ReadOnly is False that can be sent as Request body in json

format.

• {{manager_ethifc_instance}} – If this instance is usb0, PATCH is not

supported.

• PATCH on the instance for changing network settings will cause the current

connection to be terminated.

• Patch is not allowed for Ipv6/Ipv4 properties in DHCP mode. Patch of IPV6/IPV4

properties is allowed only in Static mode.

• MACaddress/PermanentMACaddress is not allowed to patch and considered as read-

only property.

Sample PATCH Request:

Sample patch request body for ethernet-interface properties for interface instance

uri,

Example: PATCH https://{{ip}}/redfish/v1/Managers/Self/

EthernetInterfaces/eth0

To change hostname and fqdn

{

“FQDN”: “NEWHOST.us.megatrends.com”,

“HostName”: “NEWHOST”

}

To disable autoneg or to change FullDuplex/SpeedMbps we need to provide

three properties

{

“AutoNeg”: false,

“FullDuplex”: true,

“SpeedMbps”: 10

}

E16160_ASMB9-iKVM_UM_V3.indb 49

E16160_ASMB9-iKVM_UM_V3.indb 49E16160_ASMB9-iKVM_UM_V3.indb 49 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

4-50

Chapter 4: Redfish Technology Pack

To enable autoneg values

{

“AutoNeg”: true

}

To patch MTUSize

{

“MTUSize”: 1450

}

To change IPv4Address details

{

“IPv4Addresses”: [

{

“Address”: “172.16.97.178”,

“Gateway”: “172.16.96.1”,

“SubnetMask”: “255.255.248.0”

}

]

}

To change IPv6Address details

{

“IPv6Addresses”: [

{

“Address”: “2001:db8:1:0:21a:2bff:fe11:1111”

}

]

}

To enable/disable interface

{

“InterfaceEnabled”: true

}

E16160_ASMB9-iKVM_UM_V3.indb 50

E16160_ASMB9-iKVM_UM_V3.indb 50E16160_ASMB9-iKVM_UM_V3.indb 50 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

ASUS ASMB9-iKVM

4-51

4.3.13 SimpleStorageCollection

This represents the collection of Simple Storage resources.

Northbound API is supported but still requires host agent support from host agent and in-

band communication channel and platform specific porting needed.

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

SimpleStorage

Content-Type: application/json

• Response

Please refer to section Computer System Collection for the JSON response

properties.

{

“FQDN”: “NEWHOST.us.megatrends.com”, “FullDuplex”: true,

“AutoNeg”: false, “MTUSize”: 1450, “SpeedMbps”: 10,

“HostName”: “NEWHOST”, “MACAddress”: “00:1a:2b:11:11:11”,

“IPv4Addresses”: [ { “Address”: “172.16.97.178”,

“Gateway”: “172.16.96.1”, “SubnetMask”: “255.255.248.0”

} ], “IPv6Addresses”: [{ “Address”: “2001:db8:1:0:21a:2b

ff:fe11:1111”} ], “InterfaceEnabled”: true

}

- Response

The response status is 204 with no body. For Error Responses refer to section 4.2.4

B and section 4.2.4 C .

E16160_ASMB9-iKVM_UM_V3.indb 51

E16160_ASMB9-iKVM_UM_V3.indb 51E16160_ASMB9-iKVM_UM_V3.indb 51 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

4-52

Chapter 4: Redfish Technology Pack

4.3.14 SimpleStorage

This is the schema definition for the Simple Storage resource. It represents the properties of

a storage controller and its directly-attached devices

Northbound API is supported but still requires host agent support from host agent and in-

band communication channel and platform specific porting needed.

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

SimpleStorage/{{system_simplestorage_instance}}

Content-Type: application/json

• Response

The response of the request will be in JSON format. The properties are mentioned in

the following table.

Table 22 Simple StorageProperty

Name Type ReadOnly Description

@odata.context String True Refer to section .4.3.1 ODATA properties

@odata.id String True Refer to section .4.3.1 ODATA properties

@odata.type String True Refer to section .4.3.1 ODATA properties

@odata.etag String True Refer to section .4.3.1 ODATA properties

Oem Object Refer to Resource Complex Types under section .4.3.3 Resource

This property will be a part of JSON response only if an

OEM property is implemented according to “ How to Add

OEM extensions (v1.1) ” document.

Id(M) String True Resource Identifier.

Name(M) String True Name of the Resource

Description String True Provides description of the resource. Refer to section .4.3.3 Resource

UefiDevicePath String True The UEFI device path used to access this storage controller. This path

is used to identify and locate the specific storage controller.

Status Object True Refer to section for Resource.Status.4.3.3 Resource

(continued on the next page)

E16160_ASMB9-iKVM_UM_V3.indb 52

E16160_ASMB9-iKVM_UM_V3.indb 52E16160_ASMB9-iKVM_UM_V3.indb 52 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

ASUS ASMB9-iKVM

4-53

4.3.15 LogServiceCollection

This represents the collection of Log Service resources.

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

LogServices

Content-Type: application/json

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices

Content-Type: application/json

https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/

LogServices

Content-Type: application/json

system_instance – BIOS

manager_instance – AuditLog& SEL

chassis_instance - Logs

• Response

Please refer to section 4.3.5 Resource for the JSON response properties.

Name Type ReadOnly Description

Devices Array True This object shall contain identification information for this processor.

Name Type ReadOnly Description

Oem Object False Refer to section 4.3.3 Resource

for Resource.Oem.

Name (M) String True Name of the resource or array

element.

Status Object True Refer to section 4.3.3 Resource

for Resource.Status.

Manufacturer String True Name of the manufacturer of this

storage device.

Model String True Model number of this device.

E16160_ASMB9-iKVM_UM_V3.indb 53

E16160_ASMB9-iKVM_UM_V3.indb 53E16160_ASMB9-iKVM_UM_V3.indb 53 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

4-54

Chapter 4: Redfish Technology Pack

4.3.16 Log Service

This resource represents the log service for the resource or service to which it is associated.

This resource shall be used to represent a log service for a Redfish implementation.

BIOS logs are supported under Systems LogServices.

/redfish/v1/Ssytems/Self/LogServices/BIOS

AuditLog, EventLog& SEL are supported under Manager LogServices.

/redfish/v1/Managers/Self/LogServices/AuditLog

/redfish/v1/Managers/Self/LogServices/SEL

/redfish/v1/Managers/Self/LogServices/EventLog

Logs are supported under Chassis LogServices.

/redfish/v1/Chassis/Self/LogServices/Logs

IPMI SEL Logs

IPMI SEL Logs include System BIOS Logs and Managers SEL Logs and Chassis Logs.

These Logs will be reflected in Redfish only when “ServiceEnabled” property is true.

IPMI Oem SEL logs would be displayed only when platform/oem specific porting support is

added.

A. System BIOS Logs

Clearing BIOS related SEL entries through IPMITool will reflect in Redfish in /Systems/

Self/LogServices/BIOS/Entries .

On delete cascade:

User can configure this option through System Builder. It can take any of the following

boolean values: Please refer to System Builder User Guide(v1.1) for further reference.

False - Clearing BIOS related SEL entries from Redfishwill clear only in Redfish and will not

clear the actual logs from IPMI and hence will not be in sync.

True - Clearing BIOS related SEL entries from Redfishwill clear in both Redfish and IPMI and

the logs in IPMI and Redfish will be in sync.

Please refer to section 1.4.9 in System Log Service under Configurable properties in “ How to

Add OEM extensions (v1.1) ” document for redis Keys.

Example: SET Redfish:Systems:Self:LogServices:BIOS:onDeleteCascade

true/false in systems.rcmd under db_init in redfish_core package should be modified at

buildtime

B. Chassis Logs

The following SEL Logs will be displayed under Chassis:

Temperature, Fan, Voltage, Current, Physical Intrusion, Power Supply and Power Unit.

• Clearing Chassis Logs

Clearing SEL entries through IPMITool will reflect in Redfish in /Chassis/Self/

LogServices/Logs/Entries .

E16160_ASMB9-iKVM_UM_V3.indb 54

E16160_ASMB9-iKVM_UM_V3.indb 54E16160_ASMB9-iKVM_UM_V3.indb 54 1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM

1/17/2020 2:29:28 PM1/17/2020 2:29:28 PM

On delete cascade

False

True

How to Add OEM extensions (v1.1)

SET

Redfish:Chassis:Self:LogServices:Logs:onDeleteCascade

C. Manager Event Logs

• Manager SEL Logs

/Chassis/Self/

LogServices/Logs/Entries

On delete cascade

False

True

How to Add OEM extensions (v1.1)

SET

Redfish:Managers:Self:LogServices:SEL:onDeleteCascade

D. Max Log Entries –SPI Image

E. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

LogServices/{{system_log_instance}}

Content-Type: application/json

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices/{{manager_log_instance}}

Content-Type: application/json

https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/

LogServices/{{chassis_log_instance}}

Content-Type: application/json

• Response

Table 23 Log ServiceProperties

Name Type ReadOnly Description

4.3.1 ODATA properties

4.3.3 Resource

How to Add

OEM extensions (v1.1)

Id(M)

Name(M)

4.3.3 Resource

Name Type ReadOnly Description

Enum Description

4.3.3 Resouce

4.3.3 Resource

F. PATCH

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

LogServices/{{system_log_instance}}

Content-Type: application/json

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices/{{manager_log_instance}}

Content-Type: application/json

Request Body

Table 23 Log ServiceProperties

• Response

204

200

G. POST

• Request

POST https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices/{{manager_log_instance}}/Actions/LogService.ClearLog

Content-Type: application/json

Example POST Request URL:

https://{{ip}}/redfish/v1/Managers/Self/LogServices/BIOS/

Actions/LogService.ClearLog

https://{{ip}}/redfish/v1/Managers/Self/LogServices/AuditLog/

Actions/LogService.ClearLog

Example POST Request Body:

{

“ClearType”: “ClearAll”

}

• Response

4.2.4 B

4.2.4 C

4.3.17 LogEntryCollection

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

LogServices/{{system_log_instance}}/Entries

Content-Type: application/json

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices/{{manager_log_instance}}/Entries

Content-Type: application/json

• Response

4.3.5 Computer System Collection

4.3.18 Log Entry

A. GET

• Request

https://{{ip}}/redfish/v1/Systems/{{system_instance}}/

LogServices/{{system_log_instance}}/Entries/{{system_logentry_

instance}}

Content-Type: application/json

https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/

LogServices/{{manager_log_instance}}/Entries/{{manager_logentry_

instance}}

Content-Type: application/json

• Response

Table 24 Log Entry Property

Name Type ReadOnly Description

4.3.1 ODATA properties

4.3.3 Resource

How to Add

OEM extensions (v1.1)

Id(M)

Name(M)

4.3.3 Resource

EntryType(M)

Name Type ReadOnly Description

Type String

Name Type ReadOnly Description

Type String

Produkt Specifikationer

Mærke:	Asus
Kategori:	Ikke kategoriseret
Model:	ASMB9-iKVM

Har du brug for hjælp?

Hvis du har brug for hjælp til Asus ASMB9-iKVM stil et spørgsmål nedenfor, og andre brugere vil svare dig

Dit navn*

Din email*

Skriv dit spørgsmål her

Ikke kategoriseret Asus Manualer

Asus ROG RYUJIN III 360 Manual

31 Marts 2025

Asus TUF Gaming FHD120 Manual

4 Marts 2025

Asus S14NA-U12 Manual

23 Februar 2025

Asus RT-ACRH12 Manual

12 Januar 2025

Asus R1505I-IM-B Manual

11 Januar 2025

Asus DSEB-DG/SAS Manual

11 Januar 2025

Asus NUC 14 Performance Kit Manual

1 Januar 2025

Asus EBS-S110W Manual

27 December 2024

Asus MDS-M700 Manual

27 December 2024

Asus C7146ES-IM-AA Manual

27 December 2024

Ikke kategoriseret Manualer

Nyeste Ikke kategoriseret Manualer

Draper 13909 Manual

4 Juni 2025

Lutec Aleta Manual

4 Juni 2025

Ikan PrompterPro 4 Manual

4 Juni 2025

Middle Atlantic SNE30F-4536 Manual

4 Juni 2025

Progress Lighting Northlake P300434 Manual

4 Juni 2025

Progress Lighting Atwell P710114 Manual

4 Juni 2025

POWRUI AHR-803B Manual

4 Juni 2025

Crestron CLXI-2DIMU8 Manual

4 Juni 2025

Draper 81908 Manual

4 Juni 2025

Draper 13597 Manual

4 Juni 2025