ASMB9-iKVM Server Management Board User Guide E16160_ASMB9-iKVM_UM_V3.
E16160 Revised Edition V3 January 2020 Copyright © 2020 ASUSTeK COMPUTER INC. All Rights Reserved. No part of this manual, including the products and software described in it, may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language in any form or by any means, except documentation kept by the purchaser for backup purposes, without the express written permission of ASUSTeK COMPUTER INC. (“ASUS”).
Contents Notices ....................................................................................................................... vii Safety information....................................................................................................... ix About this guide........................................................................................................... x ASMB9-iKVM specifications summary....................................................................
Contents 3.5 3.6 3.7 Logs & Reports........................................................................................... 3-5 3.5.1 IPMI Event Log............................................................................ 3-6 3.5.2 System Log.................................................................................. 3-7 3.5.3 Audit Log...................................................................................... 3-8 3.5.4 Video Log..............................................
Contents 4.3.5 Computer System Collection..................................................... 4-18 4.3.6 Computer System...................................................................... 4-19 4.3.7 Memory Collection..................................................................... 4-31 4.3.8 Memory...................................................................................... 4-32 4.3.9 ProcessorCollection................................................................... 4-39 4.3.
Contents 4.4 4.5 4.3.41 Task......................................................................................... 4-107 4.3.42 JSON Schema file collection.................................................... 4-109 4.3.43 JsonSchemaFile...................................................................... 4-109 4.3.44 SessionCollection.................................................................... 4-111 4.3.45 Session Service................................................................
Notices Federal Communications Commission Statement This device complies with Part 15 of the FCC Rules. Operation is subject to the following two conditions: • This device may not cause harmful interference, and • This device must accept any interference received including interference that may cause undesired operation. This equipment has been tested and found to comply with the limits for a Class B digital device, pursuant to Part 15 of the FCC Rules.
REACH Complying with the REACH (Registration, Evaluation, Authorization, and Restriction of Chemicals) regulatory framework, we published the chemical substances in our products at ASUS website at http://csr.asus.com/english/REACH.htm. ASUS Recycling/Takeback Services ASUS recycling and takeback programs come from our commitment to the highest standards for protecting our environment.
Safety information Electrical safety • To prevent electrical shock hazard, disconnect the power cable from the electrical outlet before relocating the server. • When adding or removing devices to or from the server, ensure that the power cables for the devices are unplugged before the signal cables are connected. If possible, disconnect all power cables from the existing server before you add a device.
About this guide This user guide contains the information you need when installing and configuring the server management board. How this guide is organized This guide contains the following parts: • Chapter 1: Product Introduction This chapter describes the server management board features and the new technologies it supports. • Chapter 2: Hardware Information This chapter provides instructions on how to install the board to the server system and install the utilities that the board supports.
Conventions used in this guide To ensure that you perform certain tasks properly, take note of the following symbols used throughout this manual. DANGER/WARNING: Information to prevent injury to yourself when trying to complete a task. CAUTION: Information to prevent damage to the components when trying to complete a task. IMPORTANT: Instructions that you MUST follow to complete a task. NOTE: Tips and additional information to help you complete a task.
ASMB9-iKVM specifications summary Chipset Aspeed 2500 Internal RAM 384 MB for system 64 MB for video Internal ROM 32 MB Timers 32-bit Watchdog Timer Main features IPMI 2.0-compliant and supports KVM over LAN Web-based user interface (remote management) Virtual media Network Bonding support Form factor 22 mm x 17 mm * Specifications are subject to change without notice. xii E16160_ASMB9-iKVM_UM_V3.
Chapter 1: Product Introduction Product Introduction 1 This chapter describes the server management board features and the new technologies it supports. E16160_ASMB9-iKVM_UM_V3.
1.1 Welcome! Thank you for buying an ASUS ASMB9-iKVM server management board! The ASUS ASMB9-iKVM is an Intelligent Platform Management Interface (IPMI) 2.0-compliant board that allows you to monitor, control, and manage a remote server from the local or central server in your local area network (LAN). With ASMB9-iKVM in your server motherboard, you can completely and efficiently monitor your server in real-time. The solution allows you to reduce IT management costs and increase the productivity.
1.3 1. 2. Features IPMI 2.0 • System interface (KCS) • LAN interface (supports RMCP+) • System Event Log (SEL) • Sensor Data Record (SDR) • Field Replaceable Unit (FRU) • Remote Power on/off, reboot • Serial Over LAN (SOL) • Authentication Type: RAKP-HMAC-SHA1 • Encryption (AES) • Platform Event Filtering (PEF) • Platform Event Trap (PET) • Watchdog Timer Private I2C Bus • 3. PMBus* • 4. 6. Supports power supply for PMBus device PSMI* • 5.
7. 8. Notification • PET • SNMP Trap • e-Mail • Self diagnosing LED indicators to display hardware status • Supports damage monitoring for CPU, RAM, storage device, etc. KVM over Internet • 9. Web-based remote console Remote Update BIOS • Use Remote floppy to update BIOS 10. Remote Storage (Virtual Media) • Support two remote storage for USB/CD-ROM/DVD and image 11.
1.5 Network setup The ASMB9-iKVM server management board installed on the remote server connects to a local/central server via direct LAN connection or through a network hub. Below are the supported server management configurations. Direct LAN connection RJ-45 cable Remote console with webbased browser Remote server with ASMB9-iKVM LAN connection through a network hub Hub or router Remote server with ASMB9-iKVM ASUS ASMB9-iKVM E16160_ASMB9-iKVM_UM_V3.
1-6 E16160_ASMB9-iKVM_UM_V3.
Chapter 2: Hardware Information Hardware Information 2 This chapter provides instructions on how to install the board to the server system and install the utilities that the board supports. E16160_ASMB9-iKVM_UM_V3.
2.1 Before you proceed Take note of the following precautions before you install the server management board to the remote server system. 2.2 • Unplug the server system power cord from the wall socket before touching any component. • Use a grounded wrist strap or touch a safely grounded object or to a metal object, such as the power supply case, before handling components to avoid damaging them due to static electricity. • Hold components by the edges to avoid touching the ICs on them.
2.3 Firmware update and IP configuration You need to update the ASMB9-iKVM firmware and configure IP source before you start using the ASMB9-iKVM board. 2.3.1 Firmware update To update the firmware: 1. Insert the support CD into the optical drive. 2. Restart the remote server then press during POST to enter the BIOS setup. 3. Go to the Boot menu and set the Boot Device Priority item to [CD-ROM]. 4. When finished, press to save your changes and exit the BIOS setup. 5.
2.3.2 Configure BMC IP source static IP 1. Insert the support CD into the optical drive. 2. Restart the remote server then press 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 to save your changes and exit the BIOS setup. 5. On reboot, select Configure BMC IP Source Static IP for Shared LAN (or DM_LAN1) from the main menu and press to enter the sub-menu.
2.3.3 Configure BMC IP source DHCP 1. Insert the support CD into the optical drive. 2. Restart the remote server then press 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 to save your changes and exit the BIOS setup. 5. On reboot, select Configure BMC IP Source DHCP for Shared LAN (or DM_LAN1) from the main menu and press to enter the sub-menu.
2.4 BIOS configuration You need to adjust the settings in the BIOS setup of the remote server for correct configuration and connection to the central server. 2.4.1 • Update the remote server BIOS file following the instructions in the motherboard/ system user guide. Visit the ASUS website (www.asus.com) to download the latest BIOS file for the motherboard. • The BIOS setup screens shown in this section are for reference purposes only, and may not exactly match what you see on your screen.
2.5 Server Mgmt menu The Server Management menu displays the server management status and allows you to change the settings. OS Watchdog Timer [Disabled] This item allows you to start a BIOS timer which can only be shut off by Intel Management Software after the OS loads. Configuration options: [Disabled] [Enabled] The following items is configurable only when the OS Watchdog Timer is set to [Enabled]. OS Wtd Timer Timeout [10 minutes] Allows you to configure the length fo the OS Boot Watchdog Timer.
2.5.1 System Event Log Allows you to change the SEL event log configuration. Erase SEL [No] Allows you to choose options for erasing SEL. Configuration options: [No] [Yes, On next reset] [Yes, On every reset] When SEL is Full [Do Nothing] Allows you to choose options for reactions to a full SEL. Configuration options: [Do Nothing] [Erase Immediately] 2-8 E16160_ASMB9-iKVM_UM_V3.
2.5.2 BMC network configuration Allows you to set the BMC LAN parameter settings. 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.
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.
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 during POST to enter the BIOS setup. 3. Go to Boot menu and set the Boot Device Priority item to [CD-ROM]. 4.
ASMC8 Help Menu options Options -kcs[smic/bt/pci_smic] NetFn command data.... -bmc_ip_source source[1: Static, 2: DHCP] -bmc_ip [ip_addr] (e.g., bmc_ip 10.10.10.20) -bmc_mask [ip_mask] (e.g., bmc_mask 255.255.255.0) -bmc_gateway [ip_addr] (e.g., bmc_gateway 10.10.10.254) -pet_ip_mac [ip_addr] [mac_addr] (e.g., pet_ip_mac 10.10.10.20 010203040506) -bmc_ip_s_lan1 source[1: Static, 2: DHCP] -bmc_ip_lan1 [ip_addr] (e.g., bmc_ip 10.10.10.20) -bmc_mask_lan1 [ip_mask] (e.g., bmc_mask 255.255.255.
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. b. 3. Type ASMC8 -bmc_ip_source 1 if you want to set a static IP address.
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 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 to save your changes and exit the BIOS setup. 5.
Chapter 3: Web-based User Interface Web-based User Interface 3 This chapter tells you how to use the web-based user interface that the server management board supports. E16160_ASMB9-iKVM_UM_V3.
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 . 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.
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.
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. ASUS ASMB9-iKVM E16160_ASMB9-iKVM_UM_V3.
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 Filter By Date field, select the time period by selecting the Start Date and the End Date from the calender. 2.
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 Filter By Date field, select the time period by selecting the Start Date and the End Date from the calender. 2. From the Event Category field, select the type of event to view the events of the selected event type.
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. 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. 3.5.4 Video Log This page displays logs of available recorded video files (if the options have been configured).
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. ASUS ASMB9-iKVM E16160_ASMB9-iKVM_UM_V3.
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.
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.
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. 3-12 E16160_ASMB9-iKVM_UM_V3.
3.6.6 Network Settings The Network Settings page allows you to configure the network settings. 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. ASUS ASMB9-iKVM E16160_ASMB9-iKVM_UM_V3.
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.
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. ASUS ASMB9-iKVM E16160_ASMB9-iKVM_UM_V3.
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.
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. 3.6.
3.6.13 Video Recording This page allows you to customize the video recording settings. 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.
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.
Remote KVM interface Video 1. Pause Video: This option is used for pausing Console Redirection. 2. Resume Video: This option is used to resume the Console Redirection when the session is paused. 3. Refresh Video: This option can be used to update the display shown in the Console Redirection window. 4. Host display: If you turn this option ON, the display will be back in the server screen. 5. Capture Screen: This option allows you to screen capture the console redirection screen. Mouse 1.
Keyboard Keyboard Layout: This menu item allows you to select the keyboard layout. Send Keys 1. Hold Down: These menu items can be used to act as holding down the corresponding key when in Console Redirection. 2. Press and Release: These menu items can be used to act as a press and release on the corresponding key when in Console Redirection. Hot Keys These menu items allow you to make use of hot keys. Video Record 1.
3.8 Image Redirection This menu allows you to emulate CD/DVD/Floppy/HDD Images as media drives to host. 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. 3.9 Power Control The Power Control displays the current server power status and allows you to change the current settings.
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.
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. 3-24 E16160_ASMB9-iKVM_UM_V3.
Redfish Technology Pack 4 This chapter provides you with information on the Redfish APIs supported. E16160_ASMB9-iKVM_UM_V3.
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.
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.
Resource Resource URI LogEntry Collection /redfish/v1/Systems/{{system_ LogEntryCollection. instance}}/LogServices/{{system_ LogEntryCollection log_instance}}/Entries /redfish/v1/Managers/{{manager_ instance}}/LogServices/{{manager_ log_instance}}/Entries /redfish/v1/Chassis{{chassis_ instance}}/LogServices/{{chassis_ log_instance}}/Entries Redfish Schema Log Entry /redfish/v1/Systems/{{system_ LogEntry.v1_1_1.
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.
4.2.2 Redfish API defnition A. OData Support https://{{ip}}/redfish/v1/Managers/Self/HostInterfaces/ {{hostinterface_instance}} 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 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.
• 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.
4.2.4 Responses This section describes about the response headers, Error codes, and response format used in Redfish v0.3 update. A. Response Headers The response messages specified in this document refers to Redfish 1.0.4 Specification. B. Redfish error response In the case of an error, Redfish REST API responds with an HTTP status code, as defined by the HTTP 1.1 specification and constrained by additional requirements defined in this specification.
- 405 Method Not Found The HTTP verb specified in the request (e.g., DELETE, GET, HEAD, POST, PUT, PATCH) is not supported for this request URI. The response shall include an Allow header which provides a list of methods that are supported by the resource identified by the Request-URI. This is typically returned with POST, PATCH, DELETE, PUT on the URL for which it’s not supported. C. Status Codes The status codes of each and every response in tabulated in the chapter 6.5.2 in Redfish 1.0.
4.3 Redfish Resources This section explains the Request URI’s and JSON Responses for the allowable HTTP methods for each of the Redfish Resources as explained below from section 4.3.4 Service Root. Section 4.3.1 ODATA properties explains the OData properties that are common to all the Redfish Entities. Section 4.3.2 User Configurable Properties explains the user configurable properties and its reference document for the list. Section 4.3.
Name Type ReadOnly Desceiption @odata.etag - - ETags provide the ability to conditionally retrieve or update a resource. This value gives the timestamp at which the resource properties have been initialized or modified. According to Redfish Specification 1.1.0 under section 6.1.5 Etags, we have “An ETag is a time stamp value that changes when the underlying object changes.” So the etag for all Collection resources in Redfish will change if the etag of the underlying instances change.
Table 6 Resource Type Definitions Name Type ReadOnly Description Id String True Uniquely identifies the resource within the collection of like resources. Description Null,String True Provides a description of this resource and is used for commonality in the schema definitions. Name String True This object represents the Name property.
Reset Enum Description On Turn the system on. ForceOff Turn the system off immediately (non-graceful) shutdown. GracefulShutdown Perform a graceful system shutdown and power off. GracefulRestart Perform a graceful system shutdown followed by a restart of the system. Not Supported in Redfish v1.1.
Table 8 Resource Complex Types Links Property Name Type Description Oem Object This object represents the Oem property. It can also contain an object of type OemObject. Status Property Name Type ReadOnly Description State String True This property shall represent if this component is available or not and why. Refer to Table 7 Resource - Enum Types for Resource. State for the possible Enum values. Enabled indicates the resource is available.
Identifier Property Name Type DurableNameFormat String ReadOnly Description True Enum Description EUI This durable name shall be the hexadecimal representation of the IEEE-defined 64-bit Extended Unique Identifier as defined in the IEEE's Guidelines for 64-bit Global Identifier (EUI-64) Specification. iQN This durable name shall be in the iSCSI Qualified Name format as defined in RFC 3720 and RFC 3721.
Table 11 Service Root 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.
Name Type ReadOnly Description Links(M) 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. PropertyName 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.
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.
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. Links Object True Enum Description Physical A computer system. Virtual A virtual machine instance running on this system. OS A computer system.
Name Type ReadOnly Description 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.
Name Type ReadOnly Description Model String True Model number of this system. • Platform specific porting needed. Refer to Platform Specific Properties section in “How to Add OEM extensions (v1.1)” document. • This can be populated by Host Interface, (Extra Bios Support is needed, now is). SKU String True The value of this property shall contain the manufacturer Stock Keeping Unit (SKU) for the system. This property will be populated if SMBIOS dump is present in BMC.
Name Type ReadOnly Description HostName String False The value of this property shall be the host name for this system, as reported by the operating system or hypervisor. This value is typically provided to the Manager by a service running in the host operating system. Northbound API is supported but still requires host interface and host agent support from host agent and inband communication channel and platform specific porting needed.
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 Count Number True ReadOnly Description The number of processors in the system.
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 4.3.3 Resource. Please refer 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.
Name Type NetworkInterfaces(N) Object ReadOnly Description 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.
Table 13 ComputerSystem – Boot Properties This object shall contain properties which describe boot information for the current resource. Changes to this object do not alter the BIOS persistent boot order configuration. • BootSourceOverrideTarget is set to a default value of “None” and can be changed only when the data is sent from BIOS (BIOS should support Redfish) or set by end-user using PATCH request (Enum values are selectively patchable with respect to Redfish support in BIOS).
Name Type ReadOnly Description Enum Description UefiShell Boot to the UEFI Shell. This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. UefiTarget Boot to the UEFI Device specified in the UefiTargetBootSourceOverride property. This property is patchable only when BIOS supports Redfish and BIOS should send this property to BMC at BIOS Boot. SDCard Boot from an SD Card.
Name Type ReadOnly Description UefiTargetBootSourceOverride String False The value of this property shall be the UEFI device path of the override boot target. The valid values for this property are specified through the Redfish.AllowableValues annotation. BootSourceOverrideEnabled = Continuous is not supported for UEFI Boot Source Override as this setting is defined in UEFI as a one time boot only.
Name Type Oem Object ReadOnly Description 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. FirmwareVersion2 String True The 2nd firmware version of this Trusted Module, if applicable. InterfaceTypeSelection String True The Interface Type selection supported by this Trusted Module.
C. POST • Request The ResetType can be one of the following values: “On”, “ForceOff”, “GracefulShutdown”, “ForceRestart”. POST https://{{ip}}/redfish/v1/Systems/Self/Actions/ ComputerSystem.Reset Content-Type: application/json Example POST Request Body: {“ResetType” : “On”} • 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. 4.3.7 Memory Collection It displays a list of Memory instances.
4.3.8 Memory Displays the information about the Memory devices like DIMM supported by the host connected to the BMC. 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 For SMBIOS, BIOS support with SMBIOS transfer capability through in-band is needed. Please refer to section 4.3.7 Memory Collection for AMI BIOS Modules for this feature. A.
Name Type ReadOnly Description MemoryType String True MemoryDeviceType String True The Type of Memory. Enum Description DRAM DRAM NVDIMM_N NVDIMM_N as defined by JEDEC. NVDIMM_F NVDIMM_F as defined by JEDEC. NVDIMM_P NVDIMM_P as defined by JEDEC. The value of this property shall be the Memory Device Type as defined by SMBIOS.
Name Type ReadOnly Description MemoryMedia Array True Media of this memory. Northbound only properties. Enum Description DRAM DRAM NVDIMM_N NVDIMM_N as defined by JEDEC. NVDIMM_F NVDIMM_F as defined by JEDEC. NVDIMM_P NVDIMM_P as defined by JEDEC. CapacityMiB Number True The value of this property shall be the Memory capacity in MiB. DataWidthBits Number True The value of this property shall be the bus width in bits.
Name Type SubsystemVendorID String ReadOnly Description True The value of this property shall be the subsystem Vendor ID of the Memory. Northbound only properties. Platform specific porting required. SubsystemDeviceID String True The value of this property shall be the subsystem Device ID of the Memory. Northbound only properties. Platform specific porting required.
Name Type ReadOnly Description MemoryLocation - - Memory connection information to sockets and memory controllers. Northbound only properties. Platform specific porting required. ErrorCorrection String True Name Type Socket Number True ReadOnly Description Socket number in which Memory is connected. MemoryController Number True Memory controller number in which Memory is connected. Channel Number True Channel number in which Memory is connected.
Name Type ReadOnly Description Regions Array - OperatingMemory Modes Array True The value of this property shall be the memory region information within the Memory. Name Type ReadOnly Description RegionId String True Unique region ID representing a specific region within the Memory OffsetMiB Number True Offset with in the Memory that corresponds to the starting of this memory region in MiB SizeMiB Number True Size of this memory region in MiB.
Name Type ReadOnly Description Status Object - Name Type ReadOnly Description State True Refer to section 4.3.3 Resource, Resource – Enum Types. Health Number True Refer to section 4.3.3 Resource, Resource – Enum Types. String • Health Status is initially “OK” if memory is populated. • Health value can be affected/changed in 2 ways: -S MI interrupt in SEL Logs. It needs AMI BIOS modules as mentioned in section 4.3.7 Memory Collection.
B. POST • Request POST https://{{ip}}/redfish/v1/Systems/{{Systems_instance}}/ Memory/{{manager_log_instance}}/Actions/AmiBios.ChangeState Content-Type: application/json Example POST Request URL https://{{ip}}/redfish/v1/Systems/Self/Memory/1/Actions/ AmiBios.ChangeState Example POST Request Body: { “State”: “Disabled” } If all the memory instances are disabled, the Host System will not bootup in the next boot. Please refer to “MegaRAC Redfish - BMC Hardware Health Management Getting Started Guide (v1.
4.3.10 Processor This is the schema definition for the Processor resource. It represents the properties of a processor attached to a System. 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 For SMBIOS, BIOS support with SMBIOS transfer capability through in-band is needed. Please refer to section 4.3.7 Memory Collection for AMI BIOS Modules for this feature.
Name Type ReadOnly Description Socket String True Identifies the physical location or socket of the processor. Status Object True Name Type ReadOnly Description State True Refer to section 4.3.3 Resource, Resource – Enum Types. Health Number True Refer to section 4.3.3 Resource, Resource – Enum Types. String • Health Status is initially “OK” if memory is populated. • Health value will be affected/changed through Sensor related logs as explained in detail in “How to Add OEM extensions (v1.
Name Type ReadOnly Description InstructionSet String True This property shall contain the string which identifies the instruction set of the processor contained in this socket. Northbound only supported. ProcessorId Object - Enum Description x86 x86 32-bit x86-64 x86 64-bit IA-64 Intel IA-64 ARM-A32 ARM 32-bit ARM-A64 ARM 64-bit MIPS32 MIPS 32-bit MIPS64 MIPS 64-bit OEM OEM-defined This object shall contain identification information for this processor.
4.3.11 Ethernet Interface Collection A. Systems This resource shall be used to represent the collection of host side NIC resources. This requires host agent support from OS and in-band communication channel.
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.
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.
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.
Name Type ReadOnly Description Ipv6StaticAddresses Array of False Objects 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.
Name Type ReadOnly Description AddressOrigin String True Gateway Table 21 String False 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). This is the Ipv4 default gateway address for this interface.
• 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.
To enable autoneg values { } “AutoNeg”: true To patch MTUSize { } “MTUSize”: 1450 To change IPv4Address details { “IPv4Addresses”: [ { “Address”: “172.16.97.178”, “SubnetMask”: “255.255.248.0” “Gateway”: “172.16.96.1”, } } ] To change IPv6Address details { “IPv6Addresses”: [ { “Address”: “2001:db8:1:0:21a:2bff:fe11:1111” } } ] To enable/disable interface { } “InterfaceEnabled”: true 4-50 E16160_ASMB9-iKVM_UM_V3.
{ “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. 4.3.
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 inband communication channel and platform specific porting needed. A.
Name Type ReadOnly Description Devices Array True 4.3.15 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.
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.
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.0) for further reference. False - Clearing SEL entries from Redfish will clear only in Redfish and will not clear the actual logs from IPMI and hence will not be in sync. True - Clearing SEL entries from Redfish will clear in both Redfish and IPMI and the logs in IPMI and Redfish will be in sync. Please refer to section 1.4.
E. GET • Request https://{{ip}}/redfish/v1/Systems/{{system_instance}}/ LogServices/{{system_log_instance}} Content-Type: application/json OR https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/ LogServices/{{manager_log_instance}} Content-Type: application/json OR https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/ LogServices/{{chassis_log_instance}} Content-Type: application/json • Response The response of the request will be in JSON format.
Name Type ReadOnly Description OverWritePolicy(C) String True Indicates the policy of the log service when the MaxNumberOfRecords has been reached or when the log is full. Enum Description Unknown The overwrite policy is not known or is undefined. WrapsWhenFull When full, new entries to the Log will overwrite previous entries.
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 The response status is 204 with no body.
4.3.18 Log Entry This resource represents the log record format for logs. It is designed to be used for SEL logs from IPMI as well as Event Logs and OEM specific logs. The EntryTypeNAME indicates the type of log and there are other properties dependent on its value. A.
Name Type ReadOnly Description EntryCode String True This property shall be present if the EntryType value is SEL. These enumerations are the values from table 42-1 and 42-2 of the IPMI specification.
Name SensorType Type String ReadOnly Description True Type String String Fully Redundant Redundancy Lost Redundancy Degraded Non-redundant:Sufficient Resources from Redundant Non-redundant:Sufficient Resources from Insufficient Resources Non-redundant:Insufficient Resources Redundancy Degraded from Fully Redundant Redundancy Degraded from Non-redundant D0 Power State D1 Power State D2 Power State D3 Power State This property shall be present if the EntryType value is SEL.
Name Type ReadOnly Description SensorNumber Number True This property decodes from EntryType: If it is SEL, it is the sensor number; if Event it is not applicable. Otherwise, it is OEM specific. Message String This property shall be the Message property of the event and decodes from EntryType: If it is Event then it is a message Description. Otherwise, it is SEL or OEM specific. In most cases, this will be the actual Log Entry. True Populated only for AuditLogs.
4.3.20 VLANNetworkInterface This resource represents the VLAN Network Interface for the resource or service to which it is associated. This resource shall be used to represent a Network Interface for a Redfish implementation. Northbound API is supported but still requires host agent support from host agent and inband communication channel and platform specific porting needed. A.
A. PATCH • Request https://{{ip}}/redfish/v1/Systems/{{system_instance}}/ EthernetInterfaces/{{system_ethifc_instance}}/VLANs/{{system_ vlan_instance}} Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 25 VLAN Network Interface for which ReadOnly is False that can be sent as Request body in json format.
• Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 26 Chassis 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.
Name Type ReadOnly Description PartNumber(C) String True The part number for this chassis. Platform specific porting needed. Please refer to Manager EthernetInterface under Platform specific Properties in “How to Add OEM extensions (v1.1)” document. AssetTag String False The user assigned asset tag for this chassis. IndicatorLED String False The state of the indicator LED, used to identify the chassis. Enum Description Unknown The state of the Indicator LED cannot be determined.
Table 27 Chassis Type Enum Properties ChassisType Enum Description Rack An equipment rack, typically a 19-inch wide freestanding unit. Blade An enclosed or semi-enclosed, typically vertically-oriented, system chassis which must be plugged into a multi-system chassis to function normally. Enclosure A generic term for a chassis that does not fit any other description. StandAlone A single, free-standing system, commonly called a tower or desktop chassis.
Table 28 Chassis Links Properties Name Type ReadOnly Description ComputerSystems(N) Array True An array of references to the computer systems contained in this chassis. This will only reference ComputerSystems that are directly and wholly contained in this chassis. ManagedBy(N) Array True An array of references to the Managers responsible for managing this chassis. ContainedBy(N) Array True A reference to the chassis that this chassis is contained by. Platform specific porting needed.
B. PATCH • Request https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}} Content-Type: application/json Example PATCH Request Body: { } “AssetTag”:”abcd”, “IndicatorLED”:”Off” Null value is not supported for PATCH requests and a 400 bad request with PropertyValueTypeError is returned. Request Body Please refer to the properties that are patchable in Table 26 Chassis Properties for which ReadOnly is False that can be sent as Request body in json format.
4.3.23 Power This resource shall be used to represent a power metrics resource for a Redfish implementation. A. GET • Request https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/Power Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 29 Power Properties Name Type ReadOnly Description @odata.context String True Refer to section 4.3.1 ODATA properties. @odata.
Table 30 PowerControl Properties Name Type ReadOnly Description Name(C) String True PowerConsumedWatts Number True Power Control Function name. The actual power being consumed (in Watts) by the chassis. Minimum Value: 0. Northbound only properties. Platform specific porting required. PowerRequestedWatts Number True The amount of power (in Watts) that the chassis resource is currently requesting be budgeted to it for future use. Minimum Value: 0. Northbound only properties.
Name Type ReadOnly Description Attribute Type Description MaxConsumed Number The highest power consumption level that has Watts occured over the measurement window (the last IntervalInMin minutes). Minimum Value: 0. Average Consumed Watts PowerLimit Object RelatedItem(C) Table 31 Array False True Number The average power level over the measurement window (the last IntervalInMin minutes). Minimum Value: 0. Power limit status and configuration information for this chassis.
Name Type ReadOnly Description UpperThreshold Fatal(C) Number True The value of this property shall indicate the CurrentReading is above the normal range and is fatal. Units shall use the same units as the related ReadingVolts property. LowerThreshold NonCritical(C) Number True The current reading is below the normal range but is not critical. Units shall use the same units as the related ReadingVolts property.
Name Type ReadOnly Description LineInputVoltage Type(C) String True The LineInputVoltage at which the power supply is operating this resource. Enum Description Unknown The power supply line input voltage type cannot be determined. ACLowLine 100-127V AC input. Deprecated: Use AC120V. ACMidLine 200-240V AC input. Deprecated: Use AC240V ACHighLine 277V AC input. Deprecated: Use AC277V. DCNeg48V -48V DC input. DC380V High Voltage DC input (380V) AC120V AC 120V nominal input.
B. PATCH • Request https://{{ip}}/redfish/v1/Chassis/{{chassis_instance}}/Power Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 29 Power Properties for which ReadOnly is False that can be sent as Request body in json format. • Response The response status is success with status code as 200 with GET response body. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.3.
Name Type ReadOnly Description Description String True Temperatures Array of False Objects This is the definition for temperature sensors. Refer to Table 35 Temperature Properties. Fans Array of False Objects This is the definition for fans. Refer to Table 37 Fan Properties. Redundancy(N)(C) Array This structure is used to show redundancy for fans. The Component ids will reference the members of the redundancy groups. True Provides description of the resource. Refer to section 4.3.
Table 36 ThermalPhysicalContextEnum Properties PhysicalContext Enum Description Room The room. Intake The intake point of the chassis. Exhaust The exhaust point of the chassis. Front The front of the chassis. Back The back of the chassis. Upper The upper portion of the chassis. Lower The lower portion of the chassis. CPU A Processor (CPU). GPU A Graphics Processor (GPU). Backplane A backplane within the chassis. SystemBoard The system board (PCB). PowerSupply A power supply.
Name Type ReadOnly Description UpperThreshold Fatal(C) Number True The current reading is above the normal range and is fatal. Units shall use the same units as the related Reading property. LowerThreshold NonCritical(C) Number True The current reading is below the normal range but is not critical. Units shall use the same units as the related Reading property. LowerThreshold Critical(C) Number True The current reading is below the normal range but is not yet fatal.
4.3.26 Manager This is the schema definition for a Manager. Examples of managers are BMCs, Enclosure Managers, Management Controllers and other subsystems assigned manageability functions. A. GET • Request https://{{ip}}/redfish/v1/Managers/{{manager_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 38 Manager Properties Name Type ReadOnly Description @odata.
Name Type ReadOnly Description SensorNumber Number True This property decodes from EntryType: If it is SEL, it is the sensor number; if Event it is not applicable. Otherwise, it is OEM specific. Links Object 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 Actions Object True Managers allows the user to perform Actions like Reset. It can also contain an Oem Object under Oem attribute under this Actions. Status Object True Refer to section 4.3.3 Resource for Resource.Oem. EthernetInterfaces(N) Object True A reference to a collection of NICs that this manager uses for network communication. It is here that clients will find NIC configuration options and settings.
Name Type ReadOnly Description ConnectTypes Supported Array True The value of ConnectTypesSupported shall be an array of the enumerations provided here. Enum Description SSH The controller supports a Serial Console connection using the SSH protocol. Telnet The controller supports a Serial Console connection using the Telnet protocol. Telnet support is based on the AMI SPX based Firmware support.
Name Type Table 41 ReadOnly Description Enum Description IPMI The controller supports a CommandShell connection using the IPMI protocol. Oem The controller supports a CommandShell connection using an OEM-specific protocol. GraphicalConsole Properties Name Type ReadOnly Description ServiceEnabled Boolean False Indicates if the service is enabled for this manager. MaxConcurrent Sessions String True Indicates the maximum number of concurrent service sessions supported by the implementation.
C. POST • Request POST https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/ Actions/Manager.Reset Content-Type: application/json Request Body The only valid value for ResetType is ForceRestart, which will do a cold reset of the BMC. Example POST Request Body: { “ResetType” : “ForceRestart” } • Response The response status is 204 and no body. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.3.
Name Type ReadOnly Description @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.
Name Type ReadOnly Description SSDP Object False This object shall contain information for the SSDP protocol settings for this manager. Simple Service Discovery Protocol (SSDP) is for network discovery of devices supporting the Redfish service. The default value of the Port property should be 1900 for compatibility with established client implementations. Refer to Table 44 SSDP Protocol Properties below. Northbound only supported. Platform Specific Porting needed.
Name Type ReadOnly Description NotifyTTL Number False The value of this property shall contain the Time-To-Live hop count used for multicast NOTIFY messages. The recommended value is 2. NotifyIPv6Scope String The value of this property shall contain the IPv6 scope used for multicast NOTIFY messages. The valid enumerations are a subset of the available IPv6 Scope types. False Enum Description Link SSDP Notify messages are sent to addresses in the IPv6 Local Link scope.
4.3.28 SerialInterfaceCollection This schema defines an asynchronous collection of serial interface resource. This resource shall be used to represent serial resources as part of the Redfish specification. A. GET • Request https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/ SerialInterfaces Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. 4.3.
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. Interface Enabled Boolean False This indicates whether this interface is enabled. BitRate String The receive and transmit rate of data flow, typically in bits-per-second (bps), over the serial connection and can take any one of the following enum values.
B. PATCH • Request PATCH https://{{ip}}/redfish/v1/Managers/{{manager_instance}}/ SerialInterfaces/{{manager_serialifc_instance}} Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 45 Serial Interface Property for which ReadOnly is False that can be sent as Request body in json format.
4.3.31 Account Service This resource shall be used to represent a management account service for a Redfish implementation. Allows user to create multiple account with different roles and privileges. A. GET • Request https://{{ip}}/redfish/v1/AccountService Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 46 Account Service Property Name Type ReadOnly Description @odata.
Name Type ReadOnly Description AccountLockout Duration(C) Number False This property shall reference the period of time in seconds that an account is locked after the number of failed login attempts reaches the threshold referenced by Account Lockout Threshold, within the window of time referenced by Account Lockout Counter Reset After. The value shall be greater than or equal to the value of Account Lockout Reset After. If set to 0, no lockout shall occur. Minimum Value: 0.
4.3.32 ManagerAccountCollection It is a collection of resources that represents the user accounts. A. GET • Request https://{{ip}}/redfish/v1/AccountService/Accounts Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. B. POST [Creating new Account] • • Make sure ServiceEnabled property in AccountService is true for creating an account.
4.3.33 Manager Account This resource shall be used to represent resources that represent the user accounts for the manager. Default Administrator Account can be created using system-builder application. A. GET • Request https://{{ip}}/redfish/v1/AccountService/Accounts/{{account_ instance}} Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table.
Name Type ReadOnly Description Locked Boolean False This property (when set to true) shall indicate that the account service has automatically locked the account due to the property accountLockoutThreshold having been exceeded. If Locked is set to true by account service, the account is locked and the user shall not be able to login redfish unless the property is unlocked by administrator. If set to false, the account will not be locked.
• Response The response status is success with status code as 204 and no body. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.3.34 Role Collection It displays a collection of ID’s subscribed to the roles in Redfish. A. GET • Request https://{{ip}}/redfish/v1/AccountService/Roles Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. B.
Example POST Request: { “AssignedPrivileges”: [ “ConfigureUsers”, “ConfigureManager”, “ConfigureSelf”, “Login”, “ConfigureComponents” ], “Description”: “TestRole User Role”, “Id”: “TestRole”, “Enabled”: true, “IsPredefined”: true, “Name”: “TestRole Role”, “OemPrivileges”: [ “OemPowerControl”, “OemClearLog” } • ] Response The response status is 201 and the response body is a GET Response with the properties of the newly created Account. For Error Responses refer to section 4.2.
Table 48 Role 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.
Example Request Body for Editing an Account: { “AssignedPrivileges”: [ “ConfigureComponents”, “Login”, “ConfigureSelf” } • ] Response The response status is success with status code as 200 and the updated Role. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. PATCH is supported for User defined Roles and is not supported for Predefined Roles.
• Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 49 Event Service Property 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.
B. PATCH • Request PATCH https://{{ip}}/redfish/v1/EventService Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 49 Event Service Property for which ReadOnly is False that can be sent as Request body in json format. Example Request Body for Enabling or Disabling EventService: { } • “ServiceEnabled”: true, Response The response status is success with status code as 204 and no body. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. C.
4.3.37 Event SubscriptionCollection It displays a collection of ID’s subscribed to this Redfish EventService and conforms to the Event Destination Collection Schema. A. GET • Request https://{{ip}}/redfish/v1/EventService/Subscriptions Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. B.
4.3.38 Event Subscription This resource shall be used to represent resources that represent the Event Subscriptions and conforms to the Event Destination Schema. A subscription instance is shown only when events are subscribed or posted using POST Action. A. GET • Request https://{{ip}}/redfish/v1/EventService/Subscriptions/ {{Subscriptions_instance}} Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table.
Name Type ReadOnly Description Context String False A client-supplied Description that is stored with the event destination subscription. This property shall contain a client supplied context that will remain with the connection through the connections lifetime. Protocol String True The protocol type of the event connection. This property shall contain the protocol type that the event will use for sending the event to the destination.
4.3.39 Task Service This resource shall be used to represent a task service for a Redfish implementation. It represents the properties for the service itself and has links to the actual list of tasks. A. GET • Request https://{{ip}}/redfish/v1/TasksService Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 51 Task Service Property Name Type ReadOnly Description @odata.
B. PATCH • Request PATCH https://{{ip}}/redfish/v1/TaskService Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 51Task Service Propertyfor which ReadOnly is False that can be sent as Request body in json format. Example Request Body for Enabling or Disabling TaskService: { } • “ServiceEnabled”: true, Response The response status is success with status code as 200 with GET response. For Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.
4.3.41 Task This URI represents the details of the task created. Check the response for its attributes. This URI will be available only if any tasks are added onto Tasks Collection. A. GET • Request https://{{ip}}/redfish/v1/TaskService/Tasks/{{task_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 52 Task Property Name Type ReadOnly Description @odata.
Name Type ReadOnly Description Enum Description Interrupted Task has been interrupted. Interrupted shall be used to indicate that the Task was interrupted (e.g., by a server crash) in the middle of processing, and the user should either re-run/ restart the Task. Pending Task is pending and has not started. Pending shall be used to indicate that the Task has been queued and will be scheduled for processing as soon as resources are available to handle the request.
4.3.42 JSON Schema file collection It displays the collection of links to each schema hosted locally for the OEM JSONSchemaFiles. The list will be populated and point the odata.id links to the JSONSchemas, only if any OEM URI’s are present otherwise the Members list will be empty. A. GET • Request https://{{ip}}/redfish/v1/JsonSchemas Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. 4.3.
Name Type ReadOnly Description 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.
4.3.44 SessionCollection It displays the collection of links to each session. The list will be populated and point the odata.id links to the session resources, only if the sessions are created via the below given POST API otherwise the Members list will be empty. A. GET • Request https://{{ip}}/redfish/v1/SessionService/Sessions Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. B.
4.3.45 Session Service This resource shall be used to represent the Session Service Properties for a Redfish implementation. It represents the properties for the service itself and has links to the actual list of sessions. A. GET • Request https://{{ip}}/redfish/v1/SessionService Content-Type: application/json • Response The response of the request will be in JSON format. The properties are mentioned in the following table. Table 55 SessionService Property Name Type ReadOnly Description @odata.
B. PATCH • Request PATCH https://{{ip}}/redfish/v1/SessionService Content-Type: application/json Request Body Please refer to the properties that are patchable in Table 55SessionService Property for which ReadOnly is False that can be sent as Request body in json format. Example Request Body for Enabling or Disabling SessionService and setting the session timeout: { “ServiceEnabled”: true, “SessionTimeout”: 300 } • Response The response status is success with status code as 200 with GET response.
Name Type ReadOnly Description 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.
4.3.48 MessageRegistryFile This is the schema definition for the Schema File locator resource. This resource shall be used to represent the Schema File locator resource for a Redfish implementation. For Example: /redfish/v1/Registries/Base.1.0.0 represents the Base Registry containing the messages for the redfish server. A. GET • Request https ://{{ip}}/redfish/v1/Registries/{{Registry_instance}} Content-Type: application/json • Response The response of the request will be in JSON format.
4.3.49 NetworkInterfaceCollection It displays the collection of network interface resource instances available in the system. A. GET • Request https://{{ip}}/redfish/v1/Systems/Self/NetworkInterfaces Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. 4.3.50 NetworkAdapterCollection It displays the collection of network adapter resource instances available in the system. A.
A. GET • Request https://{{ip}}/redfish/v1/Chassis/Self/NetworkAdapters/ {{NetwrokAdapter_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 58 NetworkAdapter 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.
Table 59 Name Controller Properties Type FirmwarePackage String Version ReadOnly Description True Resource Identifier. Enabled Boolean False This property shall enable (if set to true) or disable (if set to false) the account for future logins. The value of Enable over-rides the locked property. Links String Links for this controller. True Name Type PCIeDevices @odata.count Number True ReadOnly Description An integer representing the number of items in a collection.
Table 60 DataCenterBridging Properties Name Type Capable Boolean True Table 61 ReadOnly Description Whether this controller is capable of Data Center Bridging (DCB). VirtualizationOffload Properties Name Type ReadOnly Description VirtualFunction Object True SRIOV Table 62 String True Name Type ReadOnly Description DeviceMax Count Number True The maximum number of Virtual Functions (VFs) supported by this controller.
4.3.52 Storage Collection It displays the collection of storage resource instances available in the system. A. GET • Request https://{{ip}}/redfish/v1/Systems/Self/Storage Content-Type: application/json • Response Please refer to section 4.3.5 Computer System Collection for the JSON response properties. 4.3.53 SecureBoot This resource contains UEFI Secure Boot information. It represents properties for managing the UEFI Secure Boot functionality of a system.
Name Type ReadOnly Description 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.
4.4 Redfish AMI OEM Entities This Section provides the API’s that are available as part of AMI OEM Extensions. AMI OEM Extensions support should be enabled in PRJ. 4.4.1 Configurations This gives support for Certificate Authentication(CA) by enabling the user to upload the public certificate to the redfish server. This allows additional configuring of the Redfish service. This URI is available when CA support is enabled. A.
• Response The response status is success by following scenario: - The response status 200 means success and the response body is a GET Response with the changed values specified in the Patchable properties in Request body. - On error, the response status will be 400 and the body will contain the response error. For Detailed Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.4.2 PAM Configuration A.
• Response The response status is success by following scenario: - The response status 200 means success and the response body is a GET Response with the changed values specified in the Patchable properties in Request body. - A message will be included in the response when the lighttpd web server needs to be restarted. - On error, the response status will be 400 and the body will contain the response error. For Detailed Error Responses refer to section 4.2.4 B and section 4.2.4 C. 4.4.
4.5 Known Limitations 4.5.1 NULL Value Null value in JSON means Property does not have any value so in our Redfish implementation we have chosen not to display such values in GET Response neither allow in PATCH Requests. A. PATCH Requests Property with “null” value in the request is not supported for PATCH requests and a 400 bad request with PropertyValueTypeError is returned. For example: {“AssetTag”:null} is an invalid request. B.
4-126 E16160_ASMB9-iKVM_UM_V3.
Appendix Appendix The Appendix shows the location of the LAN ports for server management and BMC connector on server motherboards. This section also presents common problems that you may encounter when installing or using the server management board. E16160_ASMB9-iKVM_UM_V3.
A.1 LAN ports for server management The ASUS server motherboards that support ASMB9-iKVM comes with three (3) LAN (RJ-45) ports: one for network connection and the other two for server management. For easy identification, the LAN ports for server management are Shared LAN and DM_LAN1 ports. You must use the Shared LAN and DM_LAN1 ports for server management to connect the remote server to the local/central host (direct LAN connection) or to the network hub or router.
A.2 Troubleshooting This troubleshooting guide provides answers to some common problems that you may encounter while installing and/or using ASUS ASMB9-iKVM. These problems require simple troubleshooting that you can perform by yourself. Contact the Technical Support if you encounter problems not mentioned in this section. Problem The local/central server cannot connect to the ASMB9-iKVM board Solution 1. Check if the LAN cable is connected to the LAN port. 2.
A.3 Sensor Table Memory ECC Sensor No.
Backplane HD Sensor No.
Power Supply Sensor No.
Hardware Monitor Lun No Sensor Name Sensor Type Sensor Type Code Sensor Value or Event Type 00h 31h CPU1 Temperature Temperature 01h Threshold (01h) Upper Non-critical - going high Upper Critical - going high 00h 32h CPU2 Temperature Temperature 01h Threshold (01h) Upper Non-critical - going high Upper Critical - going high 00h 33h MB Temperature Temperature 01h Threshold (01h) Upper Non-critical - going high Upper Critical - going high 00h cch TR1 Temperature Temperature 01h Th
Lun No Sensor Name Sensor Type Sensor Type Code Sensor Value or Event Type 00h 36h +3.
Lun No Sensor Name Sensor Type Sensor Type Code Sensor Value or Event Type 00h 50h +VDDQ_GHJ_CPU2 Voltage 02h Threshold (01h) Lower Non-critical - going low Lower Critical - going low Upper Non-critical - going high Upper Critical - going high 00h 51h +VDDQ_KLM_CPU2 Voltage 02h Threshold (01h) Lower Non-critical - going low Lower Critical - going low Upper Non-critical - going high Upper Critical - going high 00h c3h +VCCIO1 Voltage 02h Threshold (01h) Lower Non-critical - going low L
Lun No Sensor Name Sensor Type Sensor Type Code Sensor Value or Event Type 01h B4h +VDDIO_IJKL_CPU2 Voltage 02h Threshold (01h) (For AMD platform only) Lower Non-critical - going low Lower Critical - going low Upper Non-critical - going high Upper Critical - going high 01h B5h +VDDIO_MNOP_CPU2 Voltage 02h (For AMD platform only) Threshold (01h) Lower Non-critical - going low Lower Critical - going low Upper Non-critical - going high Upper Critical - going high 00h A0h CPU_FAN1 Fan 0
Lun No Sensor Name Sensor Type Sensor Type Code Sensor Value or Event Type 00h AAh FRNT_FAN7 Fan 04h Threshold (01h) Lower Non-critical - going low Lower Critical - going low 00h ABh FRNT_FAN8 Fan 04h Threshold (01h) Lower Non-critical - going low Lower Critical - going low 00h ACh SYS_FAN1 Fan 04h Threshold (01h) Lower Non-critical - going low Lower Critical - going low 00h 39h SYS_FAN2 Fan 04h Threshold (01h) Lower Non-critical - going low Lower Critical - going low 00h 3Ah
A.4 Redfish Assigned Privileges User needs to have this privilege for performing the following operations: The configure portion is mainly applicable for PATCH / POST / DELETE.
ConfigureManager ConfigureManager Privilege is required for the following HTTP methods in the below given URI’s: Action URL Privilege Enforced PATCH Chassis Power Instance ConfigureManager PATCH/POST/DELETE EventService ConfigureManager PATCH/DELETE EventService/ Subscriptions ConfigureManager PATCH Manager Instance ConfigureManager PUT/POST/DELETE Manager EthernetInterface SD ConfigureManager PATCH Manager EthernetInterface Instance ConfigureManager POST Manager LogService ConfigureManager f
A.5 Redfish Reference documents • Redfish Scalable Platforms Management API Specification – DSP0266_1.1.0 • Redfish Host Interface Specification - DSP0270_1.0.0 • MegaRAC Redfish -How to Add OEM extensions (v1.1) • MegaRAC Redfish - System Builder User Guide (v1.1) • MegaRAC Redfish – HostInterface (LanOverUSB) (v1.1) • MegaRAC Redfish - BMC Hardware Health Management Getting Started Guide (v1.1) A-14 E16160_ASMB9-iKVM_UM_V3.
Simplified EU Declaration of Conformity English ASUSTeK Computer Inc. hereby declares that this device is in compliance with the essential requirements and other relevant provisions of related Directives. Full text of EU declaration of conformity is available at: www.asus.com/support Français AsusTek Computer Inc. déclare par la présente que cet appareil est conforme aux critères essentiels et autres clauses pertinentes des directives concernées.
ASUS contact information ASUSTeK COMPUTER INC. Address Telephone Fax Web site 4F, No. 150, Li-Te Rd., Peitou, Taipei 112, Taiwan +886-2-2894-3447 +886-2-2890-7798 http://www.asus.com Technical Support Telephone Fax Online Support +86-21-38429911 +86-21-58668722 ext: 9101 http://support.asus.com/techserv/techserv.aspx ASUSTeK COMPUTER INC. (Taiwan) Address Telephone Fax Web site 4F, No. 150, Li-Te Rd.
ASUS contact information ASUS COMPUTER INTERNATIONAL (America) Address Fax Web site 48720 Kato Rd., Fremont, CA 94538, USA +1-510-608-4555 http://usa.asus.com Technical Support Support fax General support Online support +1-812-284-0883 +1-812-282-2787 http://support.asus.com/techserv/techserv.aspx ASUS COMPUTER GmbH (Germany and Austria) Address Fax Web site Online contact Harkort Str. 21-23, D-40880 Ratingen, Germany +49-2102-959911 http://www.asus.de http://www.asus.
ASUS contact information ASUS Holland BV (The Netherlands) Address Web site Marconistraat 2, 7825GD EMMEN, The Netherlands http://www.asus.com Technical Support Telephone Fax E-mail Online Support +31-(0)591-5-70292 +31-(0)591-666853 advance.rma.eu@asus.com http://support.asus.com/techserv/techserv.aspx ASUS Polska Sp. z o.o. (Poland) Address Web site Ul. Postępu 6, 02-676 Warszawa, Poland http://pl.asus.
