Contents

Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide PDF

1 of 148
1 of 148

Summary of Content for Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide PDF

Bare Metal Orchestrator 1.4 Web User Interface Guide

Version 1.4

Abstract

This guide describes how to use the Bare Metal Orchestrator interface to streamline deployment and manage the infrastructure life cycle.

Dell Technologies Solutions

December 2022 Rev. 06

Notes, cautions, and warnings

NOTE: A NOTE indicates important information that helps you make better use of your product.

CAUTION: A CAUTION indicates either potential damage to hardware or loss of data and tells you how to avoid

the problem.

WARNING: A WARNING indicates a potential for property damage, personal injury, or death.

2021 - 2022 Dell Inc. or its subsidiaries. All rights reserved. Dell Technologies, Dell, and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be trademarks of their respective owners.

Preface......................................................................................................................................... 7 Revision history..........................................................................................................................................................................8 Product support....................................................................................................................................................................... 10

Contacting Dell Support................................................................................................................................................... 10

Chapter 1: Bare Metal Orchestrator overview............................................................................... 11 Bare Metal Orchestrator introduction........................................................................................................................... 11 Bare Metal Orchestrator architecture.......................................................................................................................... 12

Bare Metal Orchestrator components.................................................................................................................... 14 Validated hardware components....................................................................................................................................15 Validated hypervisors and operating systems............................................................................................................. 17 License and firmware format requirements.................................................................................................................18 Firewall port requirements............................................................................................................................................... 18 Bare Metal Orchestrator infrastructure management features and functions...................................................19

Chapter 2: Bare Metal Orchestrator Web User Interface.............................................................. 21 Log in to the web UI..........................................................................................................................................................21 Bare Metal Orchestrator web UI description............................................................................................................. 22

Chapter 3: Dashboard..................................................................................................................26 Dashboard layout...............................................................................................................................................................26 Dashboard status bar items............................................................................................................................................ 27 View Inventory card..........................................................................................................................................................28 Deployment card............................................................................................................................................................... 28 Quick Tasks card............................................................................................................................................................... 28

Chapter 4: Inventory................................................................................................................... 30 Inventory overview........................................................................................................................................................... 30 Add or remove columns................................................................................................................................................... 30 Manual device discovery.................................................................................................................................................. 31

Discover multiple devices with a CSV file - bulk discovery...............................................................................32 Delete devices....................................................................................................................................................................33 Manage compute nodes.................................................................................................................................................. 33

View compute inventory............................................................................................................................................34 Filter and search device inventory.......................................................................................................................... 35 Add tags to a single device....................................................................................................................................... 36 Edit tags.........................................................................................................................................................................38 Delete tags.................................................................................................................................................................... 39 View compute hardware............................................................................................................................................39 View compute node details........................................................................................................................................41 Edit compute node name and location...................................................................................................................46 Power on compute nodes..........................................................................................................................................47 Power off a compute node........................................................................................................................................47 Reinitialize compute nodes........................................................................................................................................48

Contents

Contents 3

Remove a hardware profile from a compute node..............................................................................................49 Apply a hardware profile to compute nodes......................................................................................................... 49 Decommission compute nodes.................................................................................................................................50 Assign compute nodes to a tenant......................................................................................................................... 50 Relinquish compute nodes from a tenant..............................................................................................................50 Factory reset.................................................................................................................................................................51 Manage devices............................................................................................................................................................51 Update BMC IP settings............................................................................................................................................52

Manage switches...............................................................................................................................................................53 View switch inventory................................................................................................................................................53 View switch details..................................................................................................................................................... 54 View Device page - switches................................................................................................................................... 55 Edit switch mode.........................................................................................................................................................56

Device status......................................................................................................................................................................57 Device health status.........................................................................................................................................................58

Chapter 5: Deployment............................................................................................................... 59 Manage deployments....................................................................................................................................................... 59 Hardware profile................................................................................................................................................................59

View hardware profiles.............................................................................................................................................. 59 Create a hardware profile..........................................................................................................................................60 Edit a hardware profile............................................................................................................................................. 104 Duplicate hardware profile.......................................................................................................................................105 Delete hardware profiles.......................................................................................................................................... 105

Firmware for deployment.............................................................................................................................................. 106 Create firmware media............................................................................................................................................. 106 Edit or delete firmware media.................................................................................................................................107

Operating systems for deployment............................................................................................................................. 107 Create operating system media..............................................................................................................................107 Editing or deleting operating system media........................................................................................................ 108 Deploy an operating system.................................................................................................................................... 108

Licenses for deployment..................................................................................................................................................111 Create license media...................................................................................................................................................111 Delete license media................................................................................................................................................... 111

OS drivers for deployment............................................................................................................................................. 112 Install OS custom drivers.......................................................................................................................................... 112 Apply a driver to a hardware profile.......................................................................................................................113 View drivers installed on a device...........................................................................................................................113

Stack deployment.............................................................................................................................................................114 Deploy a cloud stack.................................................................................................................................................. 114 Deploy a Wind River stack........................................................................................................................................115 Deploy a Red Hat OCP stack...................................................................................................................................116 Deploy TKG clusters...................................................................................................................................................117 Reinitialize stack deployment.................................................................................................................................. 119

Chapter 6: Site Management..................................................................................................... 120 Sites overview.................................................................................................................................................................. 120

High-level site creation workflow.......................................................................................................................... 120 Manage sites......................................................................................................................................................................121

4 Contents

View all sites...................................................................................................................................................................... 121 View sites on a map........................................................................................................................................................ 122 Add a site........................................................................................................................................................................... 123 Edit site details................................................................................................................................................................. 124 Set up a site for autodiscovery.................................................................................................................................... 125 Set up a site for DHCP relay.........................................................................................................................................126 Discover a device with IP scan..................................................................................................................................... 127

Reset a scan................................................................................................................................................................129 Viewing site inventory.................................................................................................................................................... 129 Delete a site...................................................................................................................................................................... 129 Reinitialize a site.............................................................................................................................................................. 129

Chapter 7: Tenants.................................................................................................................... 130 Multitenancy overview................................................................................................................................................... 130 Create a tenant................................................................................................................................................................. 131

Create a tenant admin...............................................................................................................................................131 View tenant........................................................................................................................................................................131 Edit a tenant..................................................................................................................................................................... 132

Delete a tenant user.................................................................................................................................................. 132 Delete a tenant................................................................................................................................................................. 132 Reinitialize tenant............................................................................................................................................................ 133

Chapter 8: Events...................................................................................................................... 134 View events.......................................................................................................................................................................134

Event notification panel........................................................................................................................................... 135 Filter events...................................................................................................................................................................... 136

Chapter 9: Users........................................................................................................................138 User management............................................................................................................................................................138 Create a user.................................................................................................................................................................... 138

Roles and Permissions table.................................................................................................................................... 139 View users......................................................................................................................................................................... 139 Edit a user..........................................................................................................................................................................139 Delete a user..................................................................................................................................................................... 140

Chapter 10: Logs........................................................................................................................ 141 Logs overview................................................................................................................................................................... 141

Chapter 11: Settings...................................................................................................................142 BMC credentials overview.............................................................................................................................................142

View BMC credentials...............................................................................................................................................142 Create BMC credentials........................................................................................................................................... 142 Edit BMC credentials................................................................................................................................................ 143 Delete BMC credentials............................................................................................................................................143

Backup and restore......................................................................................................................................................... 143 Create a manual backup........................................................................................................................................... 143 View backup list..........................................................................................................................................................144 Restore a backup file................................................................................................................................................ 144 Schedule backup........................................................................................................................................................ 145

Contents 5

Edit a backup schedule.............................................................................................................................................145 Delete a backup schedule........................................................................................................................................ 146

Downloads......................................................................................................................................................................... 146 Access an API token................................................................................................................................................. 146

Maintenance mode.......................................................................................................................................................... 147 Enable and disable maintenance mode ................................................................................................................ 147 View maintenance mode status ............................................................................................................................ 148

6 Contents

NOTE: This guide was accurate at publication time. Go to Dell Support (https://www.dell.com/support/home/en-us) to

ensure that you are using the latest version of this guide.

Purpose This guide provides an overview of Bare Metal Orchestrator and describes how to use the interface to streamline deployment and manage the infrastructure life cycle.

Audience This guide is intended for administrators who are responsible for managing the entire life cycle of the hardware infrastructure in their data centers.

Disclaimer This guide may contain language that is not consistent with Dell Technologies current guidelines. Dell Technologies plans to update the guide over subsequent future releases to revise the language accordingly.

Preface

Preface 7

Revision history

This revision history lists major changes to this document.

Table 1. Revisions

Date Release Description

December 2022 1.4 Updated user login section with IAM login, which replaces Kubernetes login. Updated create a user, added shared roles and permissions, added edit a user to the

bookmap as it is now supported. Updated inventory topics with Brownfield onboarding information. A Managed field was

added to the discovery options, and it appears in the Inventory table for onboarded Brownfield servers. A Manage Device option was added to Actions. Filter options now include a Managed filter.

Added Maintenance Mode feature to the Settings chapter. Created an Events chapter and updated the Dashboard to show the new Event

Notification icon. Added information about the Event Notification panel. Added stack deployment support for Red Hat OCP. Added Ubuntu 18.04 LTS and 20.04 LTS support, plus operating system installation on

HPE iLO servers in the managed cluster.

September 2022 1.3 Added a Downloads section under Settings and listed API token functionality. Updated RAID and OS Settings under Deployment to support S150 RAID controller. Updated Deploy an operating system topic with SRAID updates. Added new BIOS attributes to support SuperMicro and enabled setting telco-related BIOS

settings with Telco Optimized Profile. Created telemetry enablement topics in the Deployment section. Replaced min I/O with web server for firmware, OS, and license media uploads. Created custom driver installation topic. Updated stack deployer topics to reflect wizard overlay updates. Created Update BMC IP settings topic. Created an OS network settings topic for ESXi installation.

July 2022 1.2 Added backup and restore functionality to the Settings section. Added a factory reset topic to Inventory section. Added create user and delete user topics. Updated Firmware and OS Media topics with Media Type changes; included a note about

the webserver that is used for storing Switch media files. Added Switch functionality to the Inventory section. Added content for license media. Added Supermicro related content. Added many new BIOS and BMC attributes to Deployment section. Added IP Scan content to Site management. Added content for PXE ESXI OS deployment. Added HA overview content. Added license requirements. Added logging content. Added new fields to Compute Inventory page. Also added the ability to display or hide

table columns. Added OpenSUSE 15.3 support to the Deployment chapter. Added switch support and updated structure of the Inventory chapter.

March 2022 1.1 Merged Compute page into Inventory. Changed Lens to View settings. Added tagging to Inventory page. Changed iDRAC to BMC throughout the guide. Added multitenancy functionality.

8 Revision history

Table 1. Revisions (continued)

Date Release Description

Changed Configuration Profile to Hardware Profile throughout the guide.

November 2021 1.0 Initial release

Revision history 9

Product support Resources to help you to provision the infrastructure and fix problems.

Documentation You can find these Bare Metal Orchestrator documents on the Bare Metal Orchestrator Documentation site:

Bare Metal Orchestrator Release Notes Bare Metal Orchestrator Installation Guide Bare Metal Orchestrator Command Line Interface User's Guide Bare Metal Orchestrator Web User Interface Guide Bare Metal Orchestrator Command Line Interface Reference Guide Bare Metal Orchestrator Network Planning Guide Bare Metal Orchestrator API Guide

The Bare Metal Orchestrator API Guide is on the Dell Technologies Developer Portal site.

Bare Metal Orchestrator product support page Bare Metal Orchestrator Product Support Overview

Where to get help The Dell Technologies Support site (https://www.dell.com/support) contains important information about products and services including drivers, installation packages, product documentation, knowledge base articles, and advisories.

A valid support contract and account might be required to access all the available information about a specific Dell Technologies product or service.

Dell Technologies Support contact information Dell provides several online and telephone-based support and service options. Availability varies by country or region and product, and some services may not be available in your area.

NOTE: If you do not have an active Internet connection, you can find contact information from your purchase invoice,

packing slip, bill, or Dell product catalog.

Call 1-800-782-4362 or the support phone number for your country or region. Go to Dell Support to find the support phone number for your country or region. Tell the support person that you want to open a service request for Bare Metal Orchestrator. Give the support person your Product ID and a description of the problem.

You can also go to Dell Support and search for Bare Metal Orchestrator. The product support page requires you to sign in and enter your Product ID.

Contacting Dell Support How to contact your Dell account representative, Dell technical support, or Dell customer service.

Steps

1. Go to Dell Support and select a support category.

2. From the Choose a Country/Region list, verify your country or region. Then, select the appropriate service or support link.

10 Product support

Bare Metal Orchestrator overview This section describes Bare Metal Orchestrator architecture, validated hardware components and hypervisors, license and firmware requirements, firewall port requirements, and features and functions.

Topics:

Bare Metal Orchestrator introduction Bare Metal Orchestrator architecture Validated hardware components Validated hypervisors and operating systems License and firmware format requirements Firewall port requirements Bare Metal Orchestrator infrastructure management features and functions

Bare Metal Orchestrator introduction Bare Metal Orchestrator is an infrastructure management solution that enables Communications Service Providers (CSPs) to rapidly provision, manage, and monitor their infrastructure.

Bare Metal Orchestrator provides different interfaces for end-to-end infrastructure management and monitoring. Bare Metal Orchestrator works with the Baseboard Management Controller (BMC) and supports the following features:

NOTE: The term device includes servers and switches unless otherwise stated.

Role-based access control

Manages users, their assigned roles, and Bare Metal Orchestrator access. You can provide users with specific access and privileges that are allocated to them according to their assigned roles.

Site management Manages sites and associated devices.

Multitenancy Creates and manages multiple tenants.

DHCP support Manages the DHCP configuration.

Discovering devices

Discovers servers and switches. Collects inventory. You can also discover devices by scanning IP addresses.

Server management

Manages servers. Monitors the health of on-boarded servers.

Switch management

Manages Dell and Cisco switches. You can deploy an operating system and perform firmware updates.

Provisioning hardware

Uses hardware profile templates to provision multiple servers. You can update firmware versions, and different attributes such as Basic Input Output System (BIOS), BMC, Redundant Arrays of Inexpensive Disks Controller (RAID), and so on.

Operating system deployment

Installs an operating system. BIOS and BMC attributes were added to support different operating systems.

Power control Performs various actions on servers such as powering them on or off.

Metrics collection

Provides metrics reports with BMC statistics for server health monitoring.

Telemetry enablement

Enables telemetry collection from Dell, HPE, and Supermicro servers. Configures telemetry attributes to collect telemetry data.

Events notification

Provides success or failure event notification for the Bare Metal Orchestrator workflow status.

1

Bare Metal Orchestrator overview 11

VMware Telco Cloud Platform (TCP) stack

Deploys cloud-native and virtual network functions on 5G networks.

Wind River Cloud Platform deployment

Deploys the Wind River Cloud Platform stack and the server components of the cloud cluster that consist of the Central Cloud site.

Backup and restore

Schedules and performs manual backups of the cluster.

VMware Tanzu Kubernetes Grid (TKG) deployment

Deploys the management, shared services, and workload clusters on a TCP stack.

Red Hat OpenShift Container Platform deployment

Deploys the Red Hat OpenShift Container Platform stack on cloud clusters, including the management cluster, and support to grow the cloud cluster.

User management

Allows you to create and delete users.

Logging Gathers system logs that you can generate and view.

Factory reset Provides a way to restore a component to factory settings.

Media management

Specifies a switch or server media type for firmware, operating system, and license media.

Bare Metal Orchestrator architecture Bare Metal Orchestrator has a distributed architecture that is designed to manage large numbers of geographically distributed servers. Deploy the Bare Metal Orchestrator cluster as a single cluster or in a high availability (HA) configuration with two redundant HA nodes for enhanced reliability and performance.

The following figure illustrates the architecture of a single-node Bare Metal Orchestrator cluster:

Figure 1. Dell Technologies Bare Metal Orchestrator single-node cluster architecture

12 Bare Metal Orchestrator overview

The Bare Metal Orchestrator architecture consists of:

User interfacesBare Metal Orchestrator provides a web-based User Interface (UI), a Command Line Interface (CLI) client, and an Application Programming Interface (API). These interfaces perform remote infrastructure management tasks. All requests and actions from these interfaces reach the Global Controller (GC).

Global ControllerA fully contained management cluster that is deployed at the central office that can manage sites and servers that are associated with it. It constitutes core components and site components. For more information, see Bare Metal Orchestrator components.

Bare Metal Orchestrator high availability

Bare Metal Orchestrator supports high availability (HA) to meet the demands of continuous operation deployments. High availability assures peak performance during periods of compute-intensive operation and reduces the risk of downtime that can occur because of a single point of failure.

With high availability, the Bare Metal Orchestrator OVA is deployed on a five-node HA cluster by default. Global Controller services are deployed on the first node, which is a fully functional, scalable Bare Metal Orchestrator cluster to which two HA nodes are added. The two HA nodes function as a redundant pair for HA failover and must be reachable from the GC.

The Global Controller site data and services are fully replicated on the two HA nodes. A keepalive is used to monitor the availability of services on each node in the control plane. An automatic failover is triggered when a node failure is detected.

A redundant pair of Load Balancers provides highly reliable management access for the Bare Metal Orchestrator Web UI, CLI, and API using a virtual IP address (VIP). The VIP must be set to an available IP address on the same subnet as the two Load Balancers.

Each Load Balancer is considered a node in the five-node HA cluster and must be reachable from the GC. These servers must support NGINX.

Load Balancer key tasks:

Setting the VIP of the Load Balancers to an Available IP address in the same subnet as the two Load Balancers. Directing front-end traffic to the three control plane nodes for HA redundancy Managing load distribution Managing control planes

The following figure shows the architecture of a five-node HA deployment with distributed storage. The five-node HA cluster consists of three control plane nodes and the redundant pair of Load Balancers. All nodes and the distributed storage volumes are active.

Figure 2. Five-node HA cluster with distributed storage

Bare Metal Orchestrator overview 13

GlusterFS provides distributed file storage for the Global Controller and the two redundant HA nodes in the control plane cluster. The distributed storage volumes replicate the Bare Metal Orchestrator cluster data when using PersistentVolumeClaim (PVC).

Distributed storage can be deployed locally in the three-node control plane cluster or externally. For external storage deployments, the VMs hosting the storage volumes must be reachable by the HA cluster. A minimum of three storage nodes are required.

NOTE: The remote site uses local-path as the storage class.

Observe the following:

You cannot upgrade a single-node Bare Metal Orchestrator deployment to a five-node HA deployment. When using a local copy of the CLI as a remote client, you must specify the VIP of the server that is hosting the Load

Balancers in the user configuration file. If any two control plane nodes in a high availability deployment fail simultaneously, you must reboot the Global Controller

node before high availability functionality can resume. Using the CLI, log in to the Global Controller as installer and enter reboot.

For more information about using the CLI, see Bare Metal Orchestrator Command Line Interface User's Guide.

Bare Metal Orchestrator components

Bare Metal Orchestrator consists of core components and the site components that communicate with the BMC for provisioning the remote infrastructure.

Core components

The core components of the Global Controller node are responsible for managing Bare Metal Orchestrator. The functions of the core components are described below:

API serverallows all components in the Bare Metal Orchestrator cluster to communicate with one another through the API server.

Cert-manager controllerissues and manages certificates in Bare Metal Orchestrator. CLIa CLI client to interact with the API server. ETCDa database that stores configuration details. Each component in the cluster uses these configurations. The database

is accessible only through the API server. Web serverstores the ISO image for operating system deployment and firmware upgrades. Site controllercreates and manages all sites. Web user interfacea browser-based application to manage Bare Metal Orchestrator. Kafka brokera messaging broker that receives events from producers and provides events to consumers. Kafka servicea service that acts as a Kafka consumer that receives events from the Kafka broker. Prometheusa time-series database that saves generated events.

Common site components

Site components are responsible for connecting to bare metal devices, discovering devices, fetching inventory, and managing devices. Site components that function on both the Global Controller and worker sites are described below:

Discovery managerautomatically discovers devices that are assigned DHCP IP addresses. DHCP relayforwards DHCP packets to an external DHCP server. DHCP serverassigns the Dynamic Host Configuration Protocol (DHCP) IP to the discovered devices. Event routerallows Bare Metal Orchestrator to publish events to subscribed consumer channel. ILO-sku-packallows Bare Metal Orchestrator to onboard HPE iLO servers. Web serverhosts the images for operating system deployment, operating system updates, and firmware updates. Nso-sku-packallows Bare Metal Orchestrator to communicate with NSO to onboard and manage Cisco switches. Redfish Stock Keeping Units (SKU) packis a Remote Procedure Call (RPC) based micro service that allows Bare Metal

Orchestrator to manage hardware from different vendors. SKU packs connect with bare metal servers using the Redfish protocol.

SDN controllercreates, views, and manages Cisco switches in the Network Services Orchestrator (NSO) mode. Server controllercreates, views, and manages servers.

14 Bare Metal Orchestrator overview

Stack-sku-packallows Bare Metal Orchestrator to deploy VMware TCP stack and TKG. Supermicro-sku-packallows Bare Metal Orchestrator to onboard Supermicro servers. Switch controllercreates, views, and manages Dell switches in both Open Network Install Environment (ONIE) and

Network Operating System (NOS) modes. Switch-sku-packallows Bare Metal Orchestrator to connect to the Dell switch using SSH. Windriver-sku-packallows Bare Metal Orchestrator to manage the Wind River Cloud Platform stack. Ocp-sku-packallows Bare Metal Orchestrator to manage the Red Hat OpenShift Container Platform stack.

Global Controller site components

These site components only function on the Global Controller:

API proxya local API proxy that allows the Global Controller to communicate with Dell financial services for Utility Configuration Collector (UCC) licensing and billing purposes.

Hardware controllermanages the hardware profiles, searches for all servers that match the defined specifications, applies the settings to the servers, and updates the status to the API server. This provides a consistent method for provisioning and configuring servers.

local-registrylocal storage for Docker images. Load balancerdirects front-end traffic to the three control plane nodes for high availability (HA) redundancy. The load

balancer also provides management access for the Web UI, CLI, and API using a virtual IP address (VIP) when Bare Metal Orchestrator HA is configured.

OpenSearch dashboardinterface used to search site logs that are collected from each site in the Bare Metal Orchestrator cluster.

PXE-serviceallows operating system installation in Bare Metal Orchestrator. Stack deployerdeploys stacks such as VMware TCP and Wind River Cloud Platform to a cluster of selected servers. Tenant controllermanages tenants.

Validated hardware components Bare Metal Orchestrator is a multi-vendor platform. This section lists hardware components that have been validated for this release of Bare Metal Orchestrator.

Servers

Bare Metal Orchestrator is validated to work with the Integrated Dell Remote Access Controller 9 (iDRAC9) on validated Dell PowerEdge servers. Bare Metal Orchestrator is also validated to work with HPE iLO and Supermicro servers models listed in this section.

The following table describes the validated Dell PowerEdge 15th generation servers:

Table 2. Dell PowerEdge 15th generation servers

Validated models Supported BIOS versions

Supported iDRAC firmware versions

PowerEdge R6515 Rack Servera 2.3.6 5.00.10.20

5.10.30.00PowerEdge XE2420 Edge Server 2.12.3

PowerEdge R650 Rack Server 1.3.8

PowerEdge R750 Rack Server

PowerEdge XR11 Rack Serverb 1.3.8

1.0.2PowerEdge XR12 Rack Serverb

a. Only AMD MILAN CPUs are supported. b. Excluding HBA series controllers.

The following table describes the validated Dell PowerEdge 14th generation servers:

Bare Metal Orchestrator overview 15

Table 3. Dell PowerEdge 14th generation servers

Validated models Supported BIOS version Supported iDRAC firmware versions

PowerEdge R640 Rack Server 2.12.2 5.00.10.20

5.10.30.00PowerEdge R740 Rack Server

PowerEdge R740xd Rack Server

The following table describes the validated Supermicro and HPE servers:

Table 4. Supermicro and HPE servers

Validated models Supported firmware versions

Supermicro SYS-1019P-FRN2T 01.73.12 or higher

HPE DL325 Gen 10 Plus 2.72

HPE ProLiant e910t 2.65

HPE ProLiant DL360 Gen10 2.71

NOTE: Any known server-based limitations related to Bare Metal Orchestrator features are mentioned where the related

feature is documented.

Managed system storage

Bare Metal Orchestrator is validated to manage RAID controllers on Dell PowerEdge and HPE iLO servers.

NOTE: Only hardware RAID controllers are supported for HPE iLO servers.

The HPE Smart Array P408i-a storage controller is validated to work with Bare Metal Orchestrator. RAID types 0, 1, 5, and 10 are supported.

The following table lists the Dell RAID controllers and supported RAID types that Bare Metal Orchestrator is validated to manage on Dell PowerEdge servers:

Table 5. Validated RAID devices and supported types for managed Dell servers

Validated RAID Controllers Supported RAID types

Single PowerEdge PERC H730P RAID 0, 1, 5, and 10

Single PowerEdge PERC H740P

Single PowerEdge PERC H755

Single PowerEdge PERC H745 Front (Embedded)

Single PowerEdge PERC H750P

Switches

The following table describes the validated Dell switches and includes the supported network operating system (NOS) and firmware versions:

Table 6. Validated Dell switches

Validated models Supported NOS versions Supported firmware version

Dell PowerSwitch S5232F-ON 10.5.2.0 to 10.5.3.4 onie-firmware-x86_64- dellemc_s5200_c3538-r0.3.40.5.1-20

Dell PowerSwitch S5248F-ON

Dell PowerSwitch S5212F-ON

16 Bare Metal Orchestrator overview

Table 6. Validated Dell switches (continued)

Validated models Supported NOS versions Supported firmware version

Dell PowerSwitch S5224F-ON

Bare Metal Orchestrator is validated to work with the following Cisco switch model:

Cisco Nexus 9396PX version NX-OS 7.0(3)I5(2)

Validated hypervisors and operating systems

You can install the following hypervisors and operating systems on validated Dell PowerEdge servers that Bare Metal Orchestrator manages. Operating system deployment on HPE iLO servers and Supermicro servers is supported with some limitations.

Table 7. Validated operating systems and hypervisors for servers

Hypervisor or operating system Versions

openSUSE Leap 15.3 (openSUSE-Leap-15.3-3-DVD-x86_64-Build38.1- Media.iso)

Red Hat Enterprise Linux 8.4 (rhel-8.4-x86_64-dvd.iso)

8.5 (rhel-8.5-x86_64-dvd.iso)

Ubuntu 18.04 LTS (ubuntu-18.04.6-server-amd64.iso)

20.04 LTS (ubuntu-20.04.6-live-server-amd64.iso)

VMware ESXi (hypervisor) 7.0 u1, 7.0 u2, and 7.0 u3

Wind River Cloud Platform host operating system

21.05-b58 (wind-river-cloud-platform-host-installer-21.05- b58.iso)

NOTE: For Supermicro servers, only RHEL 8.4 and ESXi 7.0 are supported.

The following table lists operating systems that you can install on validated switches that Bare Metal Orchestrator manages.

Table 8. Validated operating systems for switches

Operating system Versions

Dell OS10 10.5.2.0-10.5.3.4

Cisco NX-OS 7.0(3)I5(2)

The following operating systems are supported for Bare Metal Orchestrator worker nodes.

Table 9. Validated operating systems for worker nodes

Operating system Versions

Debian 11

Ubuntu Server 19.10, 20.04 LTS

Bare Metal Orchestrator overview 17

License and firmware format requirements The following tables describe the required licenses for each BMC.

Table 10. Required licenses

Vendor License

iDRAC Datacenter

Supermicro SFT-OOB-LIC SFT-DCMS-SINGLE

HPE iLO iLO Advanced

The following tables list the supported firmware formats for Supermicro and HPE servers.

Table 11. Firmware updates for HPE iLO servers

Firmware Supported format

iLO 5 .bin

Chassis .bin

BIOS .signed.flash

NOTE: HPE iLO servers do not support file formats other than .bin and .signed.flash.

Table 12. Firmware updates for Supermicro servers

Firmware Supported format

BMC .bin

BIOS

Firewall port requirements

Port requirements

If you are using a firewall, you must open all ports that are listed in the following table to ensure that Bare Metal Orchestrator functions correctly. The following table lists the ports that Bare Metal Orchestrator uses.

Table 13. Port requirements

Port Required on Description

22 Global Controller (GC) and remote sites

Used for SSH access to run Ansible playbooks and for GlusterFS distributed storage.

67 Global Controller (GC) and remote sites

Used by the TFTP server. Optionally open on the remote site if PXE is used.

69 Global Controller (GC) and remote sites

Used when DHCP is configured. Optionally open on the remote site if PXE is used.

TCP/81 (HTTP) GC site Used for downloading ESXi driver into the endpoint.

123 Remote site Used for NTP synchronization.

441 GC site Used by the global web server to store operating systems and firmware images.

442 GC site Used by the internal web server.

18 Bare Metal Orchestrator overview

Table 13. Port requirements (continued)

Port Required on Description

TCP/442 (HTTPS) GC site Used for downloading firmware/ESXi images.

443 (HTTPS) and 80 (HTTP)

GC site Used by the web user interface.

2379 (TCP) GC site Used by the ETCD client for data access and management.

2380 (TCP) GC site Used by the ETCD peer for data access and management.

5047 GC site Used by localregistry.io as a docker container repository.

6443 (TCP) GC site Used for communicating with remote sites and the application programming interface (API).

8081 GC site Used for setting up remote sites.

8082 GC site Heketi CLI port.

8472 (UDP) GC and remote sites Used for Flannel VXLAN.

9345 (TCP) GC site Used for API communications.

10250 GC and remote sites Used by the kubelet node agent to register the node and manage containers.

30500 GC site Used by the global MinIO S3 to store the backups.

32569 GC site Used for Heketi pod to communicate with server.

Bare Metal Orchestrator infrastructure management features and functions This section lists the common infrastructure management functions that are available in Bare Metal Orchestrator.

Table 14. Infrastructure management features and functions

Feature Function

Automatic discovery Automatically discovers servers or switches using DHCP and collects inventory.

Backup and restore Schedule and perform manual backups of the cluster.

DHCP support Manage DHCP configuration.

Logs View collected logs in OpenSearch.

Manual discovery Create servers to add servers that are already deployed in your environment and collect their inventory.

Media management Manage firmware, operating system, or license media.

Multitenancy Create and manage tenants. You can also add or remove users and request or release servers or switches from or to the tenant.

Operating system deployment Deploy an operating system.

Power control Perform various actions on servers such as power on or off.

Provisioning hardware Provision multiple servers with hardware profile templates. You can update firmware versions and different attributes such as BIOS, BMC, RAID settings, and so on.

RBAC Manage users, their assigned roles, and provide Bare Metal Orchestrator access. You can grant users with specific access

Bare Metal Orchestrator overview 19

Table 14. Infrastructure management features and functions (continued)

Feature Function

and privileges that are allocated to them according to their assigned role.

Red Hat OpenShift Container Platform deployment Deploy the Red Hat OpenShift stack and the cloud clusters.

Server management Create servers (Greenfield and Brownfield server deployment).

View, update and delete servers, and auto-discovery.

Switch management Create, view, update and delete switches, and auto-discovery.

Site management Create and manage sites.

TCP stack deployment Deploy TCP cloud stack software.

TKG deployment Deploy TKG clusters to run application workloads.

Wind River Cloud Platform deployment Deploy Wind River Cloud Platform stack and cloud component clusters.

Metric collection Collect a snapshot of selected BMC statistics in metric reports for server health monitoring.

User management Create or delete users.

View inventory View inventory of on-boarded devices.

20 Bare Metal Orchestrator overview

Bare Metal Orchestrator Web User Interface This section describes logging in to the Bare Metal Orchestrator web user interface and lists its features and functions.

Topics:

Log in to the web UI Bare Metal Orchestrator web UI description

Log in to the web UI The web UI features Role-Based Access Control (RBAC), which is based on the IAM authorization service.

Prerequisites

Bare Metal Orchestrator must be installed and running. Use one of these browsers:

Google Chrome 89.0.4389.90 or higher Mozilla Firefox 86.0.1 or higher Microsoft Edge 89.0.774.68 or higher Safari 14.1 (16611.1.21.161.1) or higher, supported only on macOS

A Bare Metal Orchestrator user account is set up for the user. A user has been assigned a specific role that determines the permissions they have on the system. For information about

Role-Based Access Control, see the Bare Metal Orchestrator Command Line Interface User's Guide. You must add the Bare Metal Orchestrator hostname to the hosts file on your management console before you can access

Bare Metal Orchestrator using the web UI. Use the default hostname bmo-globalcontroller or the hostname that was assigned during Bare Metal Orchestrator installation. You also need the IP address of the Global Controller node. For high availability deployments, you need the VIP of the Load Balancer. For more information about access and accounts, see Bare Metal Orchestrator Installation Guide.

About this task

A user logging in to Bare Metal Orchestrator has one of the following roles that are associated with their account: Admin (global or support) User (global admin, support admin, operator, or global reader)

NOTE: If Maintenance Mode is enabled, only Support Admins can access the web interface. If a Global Admin, Operator,

or Global Reader user tries to log in when Maintenance Mode is active, the system displays an error message stating the

account is disabled and to contact an administrator.

NOTE: Bare Metal Orchestrator supports single sign-on (SSO) authentication. For more information on SSO integration,

see the Bare Metal Orchestrator Installation Guide.

Steps

1. Open a web browser and enter https:// in the address bar to display the Login screen.

where the is the hostname assigned to Bare Metal Orchestrator.

2

Bare Metal Orchestrator Web User Interface 21

Figure 3. Bare Metal Orchestrator Login screen

2. Enter a username or email.

3. Enter a password.

4. Click Log in to access the Web UI dashboard.

Bare Metal Orchestrator web UI description The Bare Metal Orchestrator web UI is a unified web interface that enables you to provision, manage, and monitor your infrastructure.

The role assigned to a user determines the operations that they can perform on the system. In other words, the web UI displays only the functionality and UI elements (menus, pages, and so on) that a user is allowed to access.

NOTE: This guide describes all the web UI functionalityassuming the user has necessary role and permissions to perform

all operations.

The following figure shows the Bare Metal Orchestrator console:

22 Bare Metal Orchestrator Web User Interface

Figure 4. Bare Metal Orchestrator console

Table 15. Dashboard items

Item Number Description

1 Masthead

2 Masthead icons

3 Sites and Unassigned Resources

4 Content panel

5 Left-side navigation menuicon view. Clicking an icon expands the list.

Masthead icons

The masthead icons provide access to online help, user logout, event notifications, and other information. The following figure shows the masthead icons.

Figure 5. Masthead icons

Bare Metal Orchestrator Web User Interface 23

Table 16. Masthead icon description

Item Number Description

1 Help menuprovides links to the Bare Metal Orchestrator Web User Interface Guide and the Dell End User License Agreement (EULA).

2 User menudisplays the logged in username and provides the following options: AboutProvides information about Bare Metal

Orchestrator. Log outEnables you to log out of the Bare Metal

Orchestrator web UI.

3 Event notificationA red dot indicates that there are event notifications. Click the icon to display the event information panel and view the five latest events.

Navigation menu

The navigation menu provides access to content panes where you can view inventory details, monitor device health, and so forth.

Figure 6. Bare Metal Orchestrator expanded navigation menu

You can select a menu option or go to a submenu. To collapse the main navigation, click the icon.

NOTE: You can hover over an icon when the menu is collapsed to display a tooltip with the menu name.

24 Bare Metal Orchestrator Web User Interface

Site Selector and Unassigned Resources

The Site Selector lets you switch between a global site and remote sites. Unassigned Resources lets you view all tenants or a particular tenant. The following figure shows these two options.

Figure 7. Site Selector and Unassigned Resources

Content panel

The information that is displayed in the Content panel varies depending on your current menu selection. This panel defaults to the Dashboard at login.

Search bar

The Search bar provides a pattern-match search of all data and information that is displayed on a page or window.

The Search bar appears on multiple pages and windows such as:

Sites page Inventory page

You can use the Search bar to locate a site or device within thousands of entries.

Pagination

This page control displays 10, 20, 50, or 100 items per page. Select the required number of items from the drop-down. The number of current items also displays.

Event Notification panel

Click the event notification icon at the upper right of the dashboard to display the Event Notification panel. This is a read-only list of the 5 most recent events. Click View All to display the Events page with a list of events.

Bare Metal Orchestrator Web User Interface 25

Dashboard Get an at-a-glance view of key status and deployment information for the computes across a selected site.

Topics:

Dashboard layout Dashboard status bar items View Inventory card Deployment card Quick Tasks card

Dashboard layout The dashboard provides up-to-the-minute status and deployment information for the selected site and provides quick access to common tasks.

The dashboard is divided into four sections: Status bar, Inventory, Deployment, and Quick Tasks.

3

26 Dashboard

Figure 8. Dashboard layout

Dashboard status bar items This topic describes the status bar items on the Bare Metal Orchestrator dashboard.

Status bar items are described in this table.

Table 17. Status bar items

Button Description

Inventory Count Displays the number of compute devices at the site. Click to open the Inventory page listing all the devices.

Critical Health Displays the number of compute devices at the site that report a Critical health status. Click to open the Inventory page that is filtered to list all devices with a Critical health status.

Failed Devices Displays the number of compute devices at the site that report a failure status. Click to open the Inventory page that is filtered to list all devices reporting a failure status.

Power Off Displays the number of compute devices at the site that have Power Off status. Click to open the Inventory page that is filtered to list all devices that are powered Off.

Dashboard 27

Table 17. Status bar items (continued)

Button Description

No Location Displays the number of compute devices at the site that have no location information, such as an aisle or rack. Click to open the Inventory page that is filtered to list all devices that have no location information.

Total Alerts Displays the total number of alerts.

View Inventory card View inventory status on the dashboard.

The Inventory card displays health status, online/offline status, power status, and provisioning status. These fields are described in this table.

Table 18. Inventory card fields

Section Description

Device Health The bar consists of up to three color-coded segments (green, yellow, and red). Each color represents a different health status. Green represents the OK status. Yellow represents Warning status. Red represents Critical status. Click a colored segment to display the number of computes with the corresponding health status.

Ready/Not Ready The bar consists of one or two color-coded segments. Green represents the Ready status, while gray represents any status other than Ready.

Power A single bar that consists of one or two colored segments. Blue represents the powered On status, while gray represents powered Off.

Provisioned The bar consists of one or two colored segments. Blue represents the provisioned status, while gray represents not provisioned.

Deployment card View deployment metrics on the dashboard.

The Deployment card displays various deployment metrics:

Number of firmware media files uploaded Number of operating system media files uploaded Number of hardware profiles defined in the system Number of stacks deployed on servers

Quick Tasks card Quickly access common tasks from the dashboard.

The Quick Tasks card displays quick access links to common tasks.

Table 19. Quick task fields

Category Task Description

Inventory View Opens the Inventory page listing all compute devices at the site

Discover Devices Link to procedures for manual device discovery

Deployment Create Hardware Profile Link to procedures for creating hardware profiles

Create Firmware Link to procedures for creating and uploading firmware media files

28 Dashboard

Table 19. Quick task fields (continued)

Category Task Description

Create OS File Link to procedures for creating and uploading operating system media files

Settings Sites Link to site management procedures

Help Getting Started Link to Bare Metal Orchestrator Web User Interface Guide

EULA Link to the End User License Agreement

Dashboard 29

Inventory View and manage servers and devices that are onboarded to Bare Metal Orchestrator.

Topics:

Inventory overview Add or remove columns Manual device discovery Delete devices Manage compute nodes Manage switches Device status Device health status

Inventory overview Use the Bare Metal Orchestrator inventory to monitor the health of devices in your network.

Bare Metal Orchestrator discovers devices and collects hardware and firmware inventory details.

On the left-side menu, click Inventory to view devices that are discovered at the selected site. You can:

View inventory information for the compute devices and their components. View inventory information for switches. View device status, power state, and health. Sort inventory data for quick visualization and understanding. Perform various actions on the devices. For example, you can power on or off compute nodes or delete them.

On the Inventory page, you can select one of the following from the View drop-down list:

Identification: This is the default view. It displays inventory details for the discovered devices. A Filter drop-down list lets you filter information that is displayed on the Inventory page. Click More Filters to view additional filters. Click Less Filters to view fewer filters. See Filter and search device inventory for steps on viewing filtered results on the Inventory page.

Resource Planning (compute only): Displays hardware information of the compute nodes.

NOTE: The Clear option only clears filters and does not clear keywords in the Search bar.

The Actions drop-down list provides access to various actions that you can perform on the selected devices.

For a list of available actions and inventory details for compute nodes, see Manage compute nodes. To view inventory details for compute nodes, see View compute inventory.

For a list of available actions and inventory details for switches, see Manage switches. To view inventory details for switches, see View switch inventory.

Add or remove columns: Click the three dots on the upper right of the Inventory table to display the Show Columns dialog. Select or clear the columns that you want to display. See Add or remove columns for more information.

Add or remove columns You can add or remove columns on the Identification and Resource Planning views on the Inventory page.

Steps

1. From the left-side menu, click Inventory. The Inventory page displays.

4

30 Inventory

2. From the View drop-down list, select either Identification or Resource Planning.

3. Click the three dots at the top far right of the table. The Show Columns dialog displays.

4. You have two options: Add column items by selecting them in the Show Columns list. Click Select All to choose all selected column items. Remove column items by clearing them in the Show Columns list.

5. Click x to close Show Columns.

6. Refresh your browser window to display column updates.

Manual device discovery You can manually discover compute nodes and switches for a selected site. Discovered devices are onboarded on the selected site.

About this task

Discover a single device using its IP address or do a bulk discovery of multiple devices using a CSV file, see Discover multiple devices with a CSV file - bulk discovery.

NOTE: Servers can be manually discovered either with full credentials or without credentials. If only partial credentials are

provided, such as a username but no password, an error occurs.

Steps

1. Select a site that has compute nodes or switches to discover. See Viewing site inventory.

2. From the left-side menu, select Inventory.

The Inventory page displays.

3. Click the Actions drop-down list and select Discover Devices.

4. In the Discover Device dialog box, select Server or Switch as the Discovery Type.

5. To discover a server using the IP address, select By IP and enter values for the following fields. Then click Save.

Table 20. Server IP discovery fields

Field Description

Managed Select Managed for Greenfield servers that are onboarded with Bare Metal Orchestrator.

Clear Managed for Brownfield servers, which are existing servers onboarded from a customer location that are now part of Bare Metal Orchestrator life cycle management.

NOTE: You can only onboard one managed device at a time.

Device Name Enter a unique name for the device.

BMC Endpoint The BMC endpoint that you enter must be expressed in http(s):// format.

Hostname Enter the hostname of the device.

Username Enter the BMC administrator login username.

Password Enter the BMC administrator login password.

NOTE: OS Configuration settingsThese configuration settings are needed when you want to collect OS inventory details such as DNS, NTP, and so forth. These settings are not related to the Managed setting.

OS IP (optional) IP address of the operating system installed on the server.

OS User (optional) Username for the operating system.

OS Password (optional) Password for the operating system.

DNS (optional) DNS for the operating system.

6. To discover a switch using the IP address, select By IP and do the following:

Inventory 31

a. Select the Discovery Mode as either ONIE or NOS. b. Enter the IP discovery values for the switch, and then click Save.

Table 21. Switch IP discovery fields - ONIE

Field Description

Switch Name Enter a unique name for the switch.

ONIE IP Address Enter the IP address for the switch.

ONIE Username Enter the username used to log in the switch.

ONIE Password Enter the password for the switch. Enter None if there is no password.

Mac Address Enter the MAC address of the switch. For example: 1A:23:4B:C5:67:80

Model Optionally, enter the model of the switch.

Vendor Optionally, enter the switch vendor.

Table 22. Switch IP discovery fields - NOS

Field Description

Switch Name Enter a unique name for the switch.

Management IP Enter the management IP address for the switch.

Username Enter the username used to log in to the switch.

Password Enter the password for the switch.

Model Optionally, enter the model of the switch.

Vendor Optionally, enter the switch vendor.

Discover multiple devices with a CSV file - bulk discovery

Prerequisites

Create a comma-separated value (.csv) file that defines the devices for bulk discovery.

For servers, the CSV content is formatted as follows:

DeviceName,BMC Endpoint,Username,Password,Hostname,Managed

where UserName and Password are for the baseboard management controller (BMC). BmcEndpoint must be expressed in http(s):// format. You can onboard multiple Managed servers with the CSV method.

For switches in ONIE mode, the CSV content is formatted as follows:

SwitchName, ONIE IP, ONIE Username, ONIE Password, Mac Address, Model, Vendor

For switches in NOS mode, the CSV content is formatted as follows:

SwitchName, Management IP, Username, Password, Mac Address, Model, Vendor

NOTE: You can omit the MAC address from the CSV string when onboarding a NOS switch. The MAC address of the NOS

switch is not a required attribute.

About this task

Discovered devices are onboarded on the selected site.

Steps

1. Select a site that has compute nodes or switches to discover. See Viewing site inventory.

32 Inventory

2. From the left-side menu, select Inventory.

The Inventory page displays.

3. Click the Actions drop-down list and select Discover Devices.

4. In the Discover Device dialog box, select Server or Switch as the Discovery Type.

5. Select the By CSV radio button.

6. Click Choose File to select your device file to upload.

7. Click Save to initiate the discovery process.

Delete devices You can delete one or more compute nodes and switches. This action immediately deletes the devices from your environment.

About this task

Bare Metal Orchestrator no longer manages or monitors deleted devices. Workloads running on the devices are unaffected by this operation.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays.

2. Click Compute or Switch to display the appropriate list of devices.

3. Click the check box for the device that you want to delete.

NOTE: To run this action on multiple devices, select all required devices.

The number of selected devices displays.

4. From the Actions drop-down list, select Delete. A confirmation dialog displays. You can select or clear the check box in the row to change your selection.

5. Select Delete and confirm the deletion when prompted.

Manage compute nodes From the Inventory page, you can display inventory and hardware information about compute nodes and their components for the selected site. You can also monitor and take appropriate actions on the nodes.

Use View to switch views and explore compute details. From the Actions drop-down list, you can perform various actions on the selected nodes. The following table provides a list of available actions:

Table 23. Available node actions

Action Description

Discover Devices Manual device discovery

Edit Device Edit compute node name and location

Add Tags Add tags to a single device

Delete Delete devices

Power On Power on compute nodes

Power Off Power off a compute node

Reinitialize Server Reinitialize compute nodes

Factory Reset Factory reset

Apply Hardware Profile Apply a hardware profile to compute nodes

Manage Device Manage devices

Inventory 33

Table 23. Available node actions (continued)

Action Description

Remove Hardware Profile Remove a hardware profile from a compute node

Assign Device Assign compute nodes to a tenant

Relinquish Device Relinquish compute nodes from a tenant

Update IP Update BMC IP settings

The following fields are available in the Identification view:

Health: Options are Healthy, Warning, and Critical. Power: Options are On or Off. Status: Options are Active, Inactive, or Failed. Managed: Options are Yes (enabled) or No (disabled). Onboarded Brownfield servers should display No, as they were

onboarded from a third-party location. IP Address Service Tag Device ID

The following fields are available from the Resource Planning view:

Hardware Model CPU Family Processor Type CPU Cores Memory IP Address (displays when you click More Filters).

NOTE: There are additional fields that you can select from Show Columns, which are accessed from the three dots menu.

View compute inventory

View compute inventory data on the Inventory page.

Prerequisites

Compute nodes must be discoverable by Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

Results

Compute node inventory details for the selected site are shown in the following table. For more information about compute nodes, see View compute node details.

Table 24. Compute inventory

Field Description

Select the check box in a row to choose one or more compute nodes.

Select the check box in the column header to choose all compute nodes.

When you select the check box, the number of selected nodes or devices displays over the column. Click the Selected link to view a dialog box. You can:

Change your selection by selecting or clearing the check box. Click the Actions drop-down list to perform various actions on the selected nodes.

34 Inventory

Table 24. Compute inventory (continued)

Field Description

Clear the check box to clear the selection. By default, the check box is enabled.

Indicates health status.

To view the health status for the compute node, hover over the health status icon in the row. For more information about the health status, see Device health status.

Indicates power status. For example: On or Off.

To view the power status for the compute node, hover over the power status icon in the row.

Status Indicates the provisioning status of compute nodes in Bare Metal Orchestrator. To view the provisioning status for the compute node, hover over the Status icon in the row.

For more information about the status, see Device status.

Managed Indicates whether a server is managed: Yes: Server is a Greenfield server that Bare Metal Orchestrator manages. No: Server is an onboarded Brownfield server that is managed at a third-party location.

IP Address IP address for the BMC of the compute node. To view more details, hover over the IP address in the row.

Service Tag Service tag of the system. This is a unique identifier that the Original Equipment Manufacturer (OEM) assigns. For example: 1XXXX00.

Device Name The device name, such as a server name.

Device ID User-defined, descriptive ID for a device. This field accepts any character.

Tag Identifies tags that are applied to a device. You can add, edit, or delete tags from this column. Tags are used to identify different groups and subgroups of devices and are also used to sort and filter information.

Site Site where a device is located.

Tenant The tenant associated with the node.

Profile The associated hardware profile.

OS IP Address The IP address where the ESXi OS is installed. By default, this field is hidden.

OS Host Name Custom hostname that the user provides. By default, this field is hidden.

NOTE: To sort entries by a category, click the arrow icon next to the field name.

Filter and search device inventory

Follow these steps to filter server and device inventory results using the available filter options. You can also narrow the displayed items with the Search box.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification or Resource Planning.

3. Click the Filter menu to display available filtering options: Identification Filters

Health: Healthy, Warning, Critical Power: On, Off Managed: Yes, No Status: Active, Inactive, Failed

Inventory 35

More Filters: IP Address, Service Tag, Device ID Resource Planning Filters

Hardware Model CPU Family Processor Type CPU Cores Memory More Filters: IP Address

NOTE: Click More Filters to display hidden filters that are not initially displayed, or Less Filters to hide these filters.

4. Click Apply to apply your filtering selections. The system returns to the Inventory page with filtered results.

5. Narrow your displayed results further by entering parameters in the Search box.

Add tags to a single device

You can add tags to a compute node on the Inventory page. You can use tags when searching for devices.

About this task

Follow these steps to add tags to a single compute node.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

3. Locate the device where you want to add tags.

4. Click Add a Tag in the Tags column. The Add Tags window opens.

Figure 9. Add Tags window

5. Enter text in the Add Tags field. The text appears as shown here.

36 Inventory

Figure 10. Added tag

6. Click + on the tag that you created. The selected tag looks like this image.

Figure 11. Selected tag

7. Optional: Create additional tags if required.

8. Click Save to apply one or more tags to a device. The system displays a success message.

Add tags to multiple devices

You can add tags to multiple compute nodes on the Inventory page. You can use these tags when searching for devices.

About this task

Follow these steps to add tags to more than one device.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

3. Select the devices that require tags by clicking the checkbox next to each device.

4. From the Actions drop-down, select Add Tags. The Add Tags window opens with multiple devices selected.

Inventory 37

Figure 12. Add tags for multiple devices

5. Enter text in the Add Tags field. The text appears below the Add Tags field.

6. Click + on the newly added tag. The selected tag displays with a check mark.

7. Optional: Create additional tags if required.

8. Click Save to apply one or more tags to the selected devices. The system displays a success message.

Edit tags

You can edit tags that are saved to one or more compute nodes.

About this task

Follow these steps to edit tags on a compute node.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

3. Locate the device whose tags that you want to edit.

4. Hover over the number link in the Tags column. The number indicates the number of tags that are assigned to a device. A dialog opens with options for editing or removing tags.

38 Inventory

Figure 13. Edit tags

5. Click Edit Tags to display the Add Tags dialog,

You can add tags or remove existing tags.

6. Click Save to apply your changes.

Delete tags

You can delete one or more tags that are applied to a compute node.

About this task

Follow these steps to delete tags from a compute node.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

3. Locate the device with tags that you want to remove.

4. Hover over the number link in the Tags column. This number indicates the number of tags that are assigned to a device.

A dialog opens with these options:

Figure 14. Delete tags

Remove one or more tags by hovering over a tag and clicking x. Delete all tags by clicking Remove All Tags.

View compute hardware

Prerequisites

Devices must be discoverable by Bare Metal Orchestrator.

Inventory 39

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Resource Planning.

Results

Hardware information for the selected device is described in the following table. For detailed information about compute nodes, see View compute node details.

Table 25. Hardware information

Field Description

Select a check box in the row to choose one or more compute nodes.

Select the check box in the column header to choose all compute nodes.

When you select the check box, the number of selected nodes or devices displays over the column. Click the Selected link to view a dialog box. You can:

Change your selection by selecting or clearing the check box. Click the Actions drop-down list to perform various actions on the selected nodes.

IP Address IP address for the BMC of the node. To view more information, hover over the IP address in the row.

System Manufacturer

Manufacturer of this device.

Model Model of this device.

CPU Model Displays the CPU model name. For example: Intel(R) Xeon Gold 6126 CPU @ 2.60 GHz. To view more information, hover over the displayed model name in the row.

Total Cores Total number of CPU cores.

Processors Number of processors.

Memory Displays the available memory. For example: 128 GB. To view more information, hover over the displayed memory in the row.

Available DIMMs The number of empty DIMM slots out of the total number of DIMM slots.

Storage Total storage capacity.

NIC Total number of Network Interface Controller (NIC) ports classified by port speed. For example: 2x10 Gbps, 2x25 Gbps

NOTE: If the port has no link, the speed is reported as Unknown.

PSU Number of Power Supply Units (PSUs). To view more information, hover over the PSU in the row.

Location Physical location of the hardware device.

NOTE:

To sort entries by category, click the arrow icon next to the field name.

You have several display options for this table:

To sort entries by category, click the arrow icon next to the field name. To add or remove columns, click the three dots at the upper right of the Hardware information table. Select or clear column

items to add or remove them from displaying in the table. See Add or remove columns for more information.

40 Inventory

View compute node details

Access the View Device page for more detailed compute node information. For each compute node, you can access the View Device page using either the IP address dialog-box or the slide-out panel.

IP address dialog box

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. Hover over the IP address of the selected node to open the dialog box.

Figure 15. Node information

Inventory 41

You can view a list of general device information, such as name, service tag, and model.

3. Click View Device to view more detailed compute node information. The View Device information for the selected device displays.

Figure 16. View Device example

Slide-out panel

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays.

2. Select a node.

3. Click anywhere in the row of the selected node (other than the IP address) to open a slide-out panel.

42 Inventory

Figure 17. Slide-out panel

The IP address of the device and a list of general device information displays at the top of the panel.

There is a list of collapsible device information panels (CPU, Memory, and so forth) at the bottom of the panel.

4. Click the arrow to expand and view more detailed hardware data and click again to collapse.

There is an image of the compute node followed by a View Device button.

5. Click View Device to view more detailed compute node information.

View Device page - servers

The View Device page provides more detailed information for compute nodes.

At the top of the page, you can see the following:

Health status Power status Device provisioning status Hardware profile (profile that is applied) Service tag

The Actions drop-down list allows you to perform the following:

Power On Power Off Delete Remove Hardware Profile Reinitialize Server Apply Hardware Profile

Inventory 43

Edit Device Edit Tags

Use the View drop-down list to switch the following page views:

Overview Resource Planning Software Configuration

The View Device page organizes device information into cards (tables or lists). Card names are listed in the card navigation pane on the left side of the page.

View Device page for serversOverview

Overview displays device data that is organized into the following cards:

Table 26. Overview cards

Card Description

Identification Displays various IDs, labels, and numbers that identify the device.

Licensing Displays the BMC license and timestamp when the device was discovered.

Resource Planning Displays details on device hardware such as cores, threads, and storage.

Monitoring Reports live system statistics and usage information (such as CPU temperature and memory usage) for monitoring server health. All statistics share the same polling interval.

Location Displays information that specifies device location.

OS and Drivers Displays information about installed drivers, including the driver type and version.

An image of the device appears at the bottom of the page.

View Device page for serversResource Planning

Resource Planning displays device hardware data that is organized into the following cards:

Table 27. Resource Planning cards

Card Description

CPU Displays processor information.

Memory Displays available memory and memory module details such as memory type, serial number, and module location.

Storage Displays information about storage devices such as device name, manufacturer, slot number, and FQDDs.

NIC Displays information about network interface cards, such as number of ports, NIC ID, NIC MAC address, and FQDDs.

PSU Displays information about power supply units such as power specs, model, and type.

PCI Inventory Displays information for PCI devices (including Ethernet and HBA adapters) such as manufacturer, slot locations, and part numbers.

Click the card name in the card navigation pane or scroll the page to the required card.

View Device page for serversSoftware

The Software view displays device software data that is organized into the following Firmware card:

44 Inventory

Table 28. Software card

Card Description

Firmware Displays a list of firmware modules along with their current version and previous version (when available).

View Device page for serversConfiguration

The Configuration view displays device configuration data that is organized into the following cards:

Table 29. Configuration cards

Card Description

BIOS Displays various BIOS information such as settings for boot, system profile, memory, and processor. Click View All BIOS Settings to view the full set of BIOS settings for a compute node.

RAID Displays information about RAID volumes such as names, media types, number of drives, FQDDs, and memory capacity.

BMC Displays BMC information such as settings for DNS, NTP, and network connectivity. Click View All BMC Settings to view the full set of BMC settings for a compute node.

BMC Users Displays information such as User Name and assigned role for each BMC user. For information about creating, updating, or deleting BMC users, go to BMC Users under BMC Settings (see BMC settings).

Click the card name in the card navigation pane or scroll the page to the required card.

View statistics for compute node

You can display statistics for a compute node.

Prerequisites

iDRAC9 firmware version 5.00.00.00 or higher A data center license for iDRACs

About this task

For each compute node, Bare Metal Orchestrator collects and reports live system statistics and usage information (such as CPU temperature and memory usage). Statistics help monitor server health, and all statistics use the same polling interval.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. Select a compute node.

3. Do one of the following for the selected compute node: Hover over the IP address to open the dialog box. Click anywhere in the row (other than the IP address) to open a slide-out panel.

4. Click View Device. The View Device page displays.

5. From the View drop-down list, select Overview. See the Monitoring card to view the latest statistics.

Inventory 45

View all BIOS settings

You can view all BIOS settings for a compute node.

About this task

For each compute node, you can display all the BIOS settings.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. Select a compute node.

3. Do one of the following for the selected compute node: Hover over the IP address to open the dialog box. Click anywhere in the row (other than the IP address) to open a slide-out panel.

4. Click View Device. The View Device page displays.

5. From the View drop-down list, select Configuration.

6. On the BIOS card, click View All BIOS Settings to open the BIOS Settings dialog box.

View all BMC Settings

Follow these steps to view all BMC settings for a compute node.

About this task

For each compute node, you can display all the BMC settings.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. Select a compute node.

3. Do one of the following for the selected compute node: Hover over the IP address to open the dialog box. Click anywhere in the row (other than the IP address) to open a slide-out panel.

4. Click View Device. The View Device page displays.

5. From the View drop-down list, select Configuration.

6. Scroll down until the BMC card is in view.

7. Click View All BMC Settings to open the BMC Settings dialog box.

Edit compute node name and location

You can edit the name and location information for a selected compute node.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the device that you want to edit.

3. Click the Actions drop-down list and select Edit Device.

46 Inventory

4. Update the fields as needed:

Table 30. Compute node name and location fields

Field Description

Device ID User-defined, descriptive ID. This field accepts any character.

Data Center Name of the data center where device is located.

Room Room where device is located.

Aisle Aisle Identifier, if applicable.

Rack Rack identifier.

Hostname Hostname for a device. Once the OS is installed, this field is disabled.

NOTE: Location information is stored on the device and in Bare Metal Orchestrator.

5. Select or clear the Enable Metrics check box to turn server statistics collection on or off.

. CAUTION: If the server BMC does not have a Datacenter license and Enable Metrics is selected, the server

goes into the Failed state. This occurs because telemetry is only supported for BMCs with a Datacenter

license. To resolve the failure, you must clear Enable Metrics, save the change, and then select Reinitialize

Server in the Actions drop-down list.

6. Click Save to confirm updates.

Power on compute nodes

You can power on one or more compute nodes.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the node that you want to power on.

NOTE: To run this action on multiple nodes, select all required nodes.

The number of nodes selected displays.

3. To power on a node, you have these options: From the Actions drop-down list, select Power On. Click the number of nodes label, and then from the Actions drop-down list, select Power On.

A confirmation dialog displays.

4. Click Yes to confirm power on.

Power off a compute node

You can power off one or more compute nodes.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator.

Inventory 47

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the node that you want to power off.

NOTE: To run this action on multiple nodes, select all required nodes.

The number of nodes selected displays.

3. To power off a node, you have these options: From the Actions drop-down list, select Power Off. Click number of nodes, and then from the Actions drop-down list, select Power Off.

A confirmation dialog displays.

4. Click Yes to confirm power off.

Reinitialize compute nodes

You can reinitialize the server on one or more compute nodes.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator.

About this task

For a server in a failed state, reinitialization takes the server out of the failed state, and then reruns inventory against the server. It reconciles the server and applies any requested changes. For servers not in a failed state, reinitialization causes reinventory of the server and reconciliation.

For servers not in the failed state, Bare Metal Orchestrator:

Reinventories the server Reconciles the server Reapplies any hardware profile that is targeting the server

For a server in the failed state, Bare Metal Orchestrator first takes the server out of the failed state and then:

Reinventories the server Reconciles the server Reapplies any hardware profile that is targeting the server

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the node that you want to reinitialize.

NOTE: To run this action on multiple nodes, select all required nodes.

The number of nodes selected displays.

3. To reinitialize a node, you have these options: From the Actions drop-down list, select Reinitialize Server. Click the number of nodes label, and then from the Actions drop-down list, select Reinitialize Server.

A confirmation dialog displays.

4. Click Yes to confirm reinitialization.

48 Inventory

Remove a hardware profile from a compute node

You can remove a hardware profile from one or more compute nodes.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the node whose hardware file that you want to remove.

NOTE: To run this action on multiple nodes, select all required nodes.

The number of selected nodes displays.

3. To remove a hardware profile on a node, you have these options: From the Actions drop-down list, select Remove Hardware Profile. Click the number of nodes label, and then from the Actions drop-down list, select Remove Hardware Profile.

A confirmation dialog displays.

4. Click Yes to confirm profile removal.

Apply a hardware profile to compute nodes

You can apply a hardware profile to one or more compute nodes.

Prerequisites

Nodes must be discoverable by Bare Metal Orchestrator. Hardware profiles must be defined.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box for the node where you want to apply a hardware profile.

NOTE: To run this action on multiple nodes, select all required nodes.

The number of nodes selected displays.

3. To apply a hardware profile to a node, you have these options: From the Actions drop-down list, select Apply Hardware Profile. Click the number of nodes label, and then from the Actions drop-down list, select Apply Hardware Profile.

The Select Hardware Profile dialog box displays.

4. From the Hardware Profile drop-down list, select the configuration that you want to apply and click Apply.

5. Click Apply again on the confirmation dialog.

NOTE: Some configuration changes may require a system reboot.

Inventory 49

Decommission compute nodes

You can decommission a compute node.

Prerequisites

On the Edit Hardware Profile dialog box, you must select the Reinitialize Drives check box to perform a secure erase on all drives.

SD cards, if present, are not erased when you select Reinitialize Drives.

About this task

Using a server, you must decommission it and put it in a clean state before returning it to the unassigned resources pool. Reinitialize the disks to put the server in a clean state. This process reverts the BMC settings, BIOS settings, RAID configuration, and so on, back to their baseline values.

NOTE: Decommissioning a server requires a baseline profile. See Baseline profile.

Steps

1. Edit the baseline profile (baseline-profile) with the instructions in Edit a hardware profile.

2. Select and apply the baseline-profile to the server you want to decommission, with the instructions in Apply a hardware profile to compute nodes.

Assign compute nodes to a tenant

You can assign one or more compute nodes to a tenant.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Click the check box next to one or more devices that you want to assign to a tenant.

3. From the Actions drop-down list, click Assign Device. The Assign Device to Tenant dialog box displays.

4. Select a tenant from the Select Tenant drop-down list.

5. Click Apply. The system asks whether you want to assign the device to the tenant.

6. Click Apply again. The system displays a status message stating that the device is assigned to a tenant.

Relinquish compute nodes from a tenant

You can relinquish assigned compute nodes from a tenant.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. Select a tenant from Unassigned Resources. The inventory for the specified tenant is displayed.

3. Click the check box next to the devices that you want to relinquish from a tenant.

CAUTION: Note the following before relinquishing a server to the unassigned resources pool:

The system runs the baseline-profile against the server and returns it to a clean state. The baseline-

profile ships with Reinitialize Drives selected, so when a server returns to the pool of unassigned

resources, the server disks are wiped. This action may cause data loss.

50 Inventory

To avoid wiping server disks, edit the baseline-profile, clear Reinitialize Drives, and click Save.

4. From the Actions drop-down list, click Relinquish Device. The system asks whether you want to remove the selected devices from the tenant.

5. Click Apply to relinquish devices.

Factory reset

Use this feature to reset BMC settings, BIOS settings, and securely erase drives.

About this task

CAUTION: Factory reset is a destructive operation. Back up any important data before attempting a factory

reset.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays.

2. Click the Compute button. The Factory Reset option is only accessible through the Compute page.

3. From the View menu, select Identification.

4. Select the check box next to the device that you want to reset to factory settings.

5. From the Actions drop-down, select Factory Reset. The Factory Reset dialog displays.

6. Enable one or more reset options: BIOSresets all BIOS attributes to factory defaults. Storagesecurely resets all drives on a device. BMCYou have these reset options for BMC:

Defaultresets all configurations to default settings except for network and user settings. Allresets all configurations to default settings, including network and user settings. Resetresets all configurations to default settings, including the network default user root.

7. Click Reset. The system displays a message that asks you to confirm this reset.

8. Click Reset again to confirm. The device is reset.

Manage devices

Follow these steps to manage devices that were onboarded as Brownfield servers. You can select one or more unmanaged servers at a time.

Prerequisites

Ensure the devices are not already managed.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the View drop-down list, select Identification.

3. Select one or more servers that you want to manage. The Managed status must display No for each server.

4. From the Actions menu, select Manage Device. The system displays a message stating that the device is now managed and asks if you want to continue.

5. Click Yes to manage the device. The system returns to the Inventory|Compute page and each device now displays Yes under the Managed column.

Inventory 51

Update BMC IP settings

You can update the IP settings for a device.

Steps

1. From the left-side menu, select Inventory.

The Inventory page is displayed.

2. Click the Compute tab.

3. Select the check box next to the device whose IP settings require an update.

4. From the Actions drop-down, select Update IP. The Update IP dialog is displayed with the current IP device settings.

Figure 18. Update IP settings

5. You can change these settings under New IP: IP Address Gateway Subnet Mask

6. Change the device settings as needed.

7. Click Save to apply these updates.

52 Inventory

Manage switches From the Inventory page, you can display inventory and hardware information about switches for the selected site. You can also monitor and take appropriate actions on the switches.

The default Identification view displays details about switches that are discovered for the selected site. From the Actions menu, you can perform various actions on the selected switches. The following table provides a list of available actions:

Table 31. Available actions

Action Description

Discover Devices Manual device discovery

Delete Delete devices

Edit Edit switch mode

The following fields are available from the Identification view:

Status: Options are Ready, Busy, Unknown, or Failed. IP Address Mac Address Service tag Device Name Site Model Mode: ONIE or NOS Vendor

View switch inventory

Prerequisites

Switches must be discovered by Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Inventory.

2. From the Inventory page, click the Switch button.

The Switches page opens with the Identification view showing.

Results

Inventory details of switches are displayed as shown in the following table. To view detailed information about a switch, follow these steps:

Table 32. Switch inventory details

Field Description

Select the check box in the row to choose one or more switches.

Select the check box in the column header to choose all switches.

When you select the check box, the number of nodes or devices that are selected is displayed over the tabular column. Click the Selected to view a dialog box. You can do the following:

Change your selection by selecting or clearing the check box. Click the Actions drop-down list to perform various actions on the selected nodes.

Status Indicates provisioning status of a switch in Bare Metal Orchestrator. To view the provisioning status for the switch, hover over the Status icon in the row. For more information about the status, see Device status.

Inventory 53

Table 32. Switch inventory details (continued)

Field Description

IP Address

IP address of the switch.

Mac Address

The MAC address of the switch.

Device Name

The user-assigned device name for the switch.

Site The site where the switch is deployed.

Model Name of the hardware model.

Mode The flavor that is assigned to the switch. Available options are ONIE or NOS.

Vendor The name of the switch vendor

NOTE:

To sort entries by a category, click the arrow icon next to the field name.

View switch details

The View Device page provides details about the switch.

About this task

You can access the View Device page using the IP address dialog box on the Inventory page.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. From the Inventory page, click the Switch button. The Switches page opens with the Identification view showing.

3. Hover over the IP address of the selected device to open the dialog box.

54 Inventory

Figure 19. View device information for a switch

4. Click View Device to view more detailed information for the switch.

View Device page - switches

The View Device page provides more detailed information for switches.

At the top of the page, you can see the following:

Status Site name Service tag

The Actions drop-down list allows you to delete the device.

Use the View drop-down list to switch the following page views:

Overview Resource Planning Software

The View Device page organizes device information into cards (tables or lists). Card names are listed in the card navigation pane on the left side of the page.

View Device page for switchesOverview

Overview displays device data that is organized into the following cards:

Table 33. Overview cards

Card Description

Identification Displays the IP address of the device, MAC address, name, service tag, PPID, product ID, and the service code.

Inventory 55

Table 33. Overview cards (continued)

Card Description

Hardware Displays details about the device hardware such as the hardware version, platform, vendor, software version, and model.

View Device page for switchesResource Planning

Resource Planning displays device hardware data that is organized into the following cards:

Table 34. Resource Planning cards

Card Description

Power Supply Displays power supply ID, status, air flow, and other information about the power supply such as vendor and hardware version (when available).

Fans Displays tray ID, status, air flow, and other information about the fan unit such as vendor and hardware version as available. Expand the Tray ID row to display more details about the fan such as the fan speed.

View Device page for switchesSoftware

Software displays device software data that is organized into the following Firmware card:

Table 35. Software card

Card Description

Firmware Displays a list of firmware modules along with their current version and previous version (when available).

Edit switch mode

You can edit the mode of an onboarded ONIE switch and change it to NOS mode.

Prerequisites

The ONIE switch must be onboarded and discoverable by Bare Metal Orchestrator.

Steps

1. From the left-side menu, click Inventory.

The Inventory page displays with Compute selected by default.

2. From the Inventory page, click the Switch button.

The Switches page opens with the Identification view showing.

3. Click the check box for the device that you want to edit.

4. Click the Actions drop-down list and select Edit Device.

5. Update the NOS details:

Table 36. NOS details

Field Description

Management IP Management IP address of the NOS switch.

Username The username required to log in to the NOS switch.

Password The password for the NOS switch.

6. Click Save to confirm updates.

56 Inventory

Device status Device status indicates the state of a server node or switch. This is useful to track the progress of a device as it undergoes state changes after certain actions or commands are applied.

Device status is useful in the following scenarios:

Day-to-day operational tasks. Diagnosing problems and planning corrective actions.

The following table describes the possible device states that display in the Status column:

Table 37. Device states

Icon States Description

Busy Indicates that one or more command executions are in progress.

Ready After a successful command execution, the device goes into the Ready state. It can also indicate that Bare Metal Orchestrator is ready to run the next command in a sequence. For example: When initializing a server node, if the command to run CollectInventory is complete, the status shows the Ready state before the next command starts. The state changes back to Busy when command execution is in progress.

Failed Indicates a failure in command execution even after maximum retries. This can happen in several scenarios. For example, because of a network outage or incorrect credentials. During retry, the state changes to Busy.

Unknown Indicates an unknown device status.

The following figure illustrates different states that the device transitions through during initialization:

Figure 20. Device transitions

For the command sequence of a server node that is being initialized, see the Bare Metal Orchestrator Command Line Interface User's Guide.

Inventory 57

Device health status This section describes the health status of devices such as compute nodes.

Table 38. Device health status

Icon Status Description

OK Indicates that there are no issues with the device and the device is working as expected.

Warning Indicates that the device is in a state that requires corrective action but does not affect overall system health.

Critical Indicates that critical problems exist with one or more components of the device. These issues must be fixed immediately.

Unknown Indicates that the health status of the device is unknown.

58 Inventory

Deployment Create reusable hardware profiles for servers managed by Bare Metal Orchestrator.

Topics:

Manage deployments Hardware profile Firmware for deployment Operating systems for deployment Licenses for deployment OS drivers for deployment Stack deployment

Manage deployments Hardware profiles are used to simplify managing servers and other devices on the network in your Bare Metal Orchestrator cluster.

You can edit BIOS and BMC settings, set up RAID volumes, configure network adapters, update firmware, and more for one or multiple devices. Using hardware profiles, you can even install operating systems on one or multiple Dell PowerEdge and HPE iLO servers.

Hardware profile

Hardware Profiles are configuration templates. These templates, or profiles, can be applied to multiple servers for rapid and reproducible configuration changes.

Use the Hardware Profile page to:

View, create, edit, duplicate, or delete hardware profiles. Update BIOS, BMC, RAID, network adapter configuration, and firmware. Deploy operating systems on one or multiple devices in the Bare Metal Orchestrator cluster. Create, edit, or delete BMC user accounts. Enable telemetry on servers.

View hardware profiles

Select Deployment > Hardware Profile. The Deployment: Hardware Profile page is displayed. You can view the list of hardware profiles on this page.

Baseline profile

Bare Metal Orchestrator ships with a special hardware profile that you can use to decommission servers. It is the baseline- profile in the hardware profile list.

The baseline-profile brings servers to a clean state. It securely wipes the disks and reverts BMC settings, BIOS settings, RAID configuration, and other settings back to selected default (baseline) values.

You can edit and customize this baseline profile as needed.

NOTE: The baseline profile cannot be deleted.

5

Deployment 59

Create a hardware profile

Steps

1. From the left-side menu, click Deployment > Hardware Profile.

2. From the Actions drop-down list, select Create.

3. Enter a Name for the hardware profile.

4. Add the required configuration settings. Under BIOS Settings, click Configure and update the required fields.

For more information, see BIOS settings.

Under BMC Settings, click Configure and update the required fields.

For more information, see BMC settings.

Under RAID Settings, click Configure and update the required fields.

For more information, see RAID settings.

Under OS Drivers, click Add to add custom drivers. For more information, see OS Drivers. Under Operating System, click Add OS and select the operating system media. Then you can configure the operating

system settings, see Operating system settings. For more information about operating system media, see Create operating system media.

Under Firmware, click Add Firmware and update the required fields.

For more information, see Create firmware media.

Under Network Adapter Settings, click Configure and update the required fields.

For more information, see Network adapter settings.

Under Telemetry Enablement, Turn On this function and click Configure to set it up. For more information, see Create a telemetry hardware profile.

Under Power Options, click Set power state to turn power on or off. For more information, see Set power options. Under OS Network Settings, click Configure and update the required fields.

For more information, see Configure OS network settings.

5. Select the Reinitialize Drives checkbox to perform a secure erase on the drives of servers targeted by this hardware profile.

CAUTION: Reinitialize Drives is a destructive operation that can result in data loss.

NOTE: SD cards (if present) and BOSS cards are not erased when you select Reinitialize Drives.

6. Click Save. The new hardware profile displays on the Deployment: Hardware Profile page.

BIOS settings

The BIOS settings are grouped under the following menus:

Boot settingsEnables you to set the boot mode and specify the boot order. CAUTION: Changing the settings may make the node unusable. Dell Technologies recommends making

changes only under the direction of technical support.

System profile settingsEnables you to set system performance settings.

CAUTION: Updating the fields may impact system performance.

System security settingsEnables you to set system security settings. Memory settingsAllows you to enable or disable memory functions. Processor settingsAllows you to set processor settings.

CAUTION: Changing the settings may make the node unusable. Contact Dell Technologies technical support

before attempting changes.

60 Deployment

Serial communicationEnables you to set the properties of the serial communication port. Integrated devicesEnables you to configure the settings of Single Root Input/Output Virtualization (SR-IOV) devices. Network settingsAllows selection of NIC ports for PXE boot. SATA settingsAllows configuration of SATA on drives. Redundant OS controlConfigures the backup device for the Redundant OS Control feature. Miscellaneous settingsConfigures various settings such as Keyboard Number Lock and Power Cycle Request.

Click the menus to view the fields and update the values. The following tables describe the BIOS settings and their supported values.

NOTE: The Finish button is enabled only after you navigate through all the menus and update the required fields.

For operating system deployments, a short list of BIOS attributes is supported.

Table 39. BIOS attributes supported for operating system deployments

Operating system Supported attributes

ESXi 6.7u3 procVirtualization: Enabled

bootMode: Uefi or Bios

serialPortAddress: Com1 or Com2

For Dell PowerEdge 14th generation servers, XR11 and XR12 Dell PowerEdge servers: Com1 For Dell PowerEdge 15th generation servers: Com2

openSUSE 15.3

Red Hat Enterprise Linux 8.4

Ubuntu (18.04 LTS and 20.04 LTS)

Wind River Cloud Platform 21.05

bootMode: Uefi

serialPortAddress: Com1 or Com2

For Dell PowerEdge 14th generation servers, XR11 and XR12 Dell PowerEdge servers: Com1 For Dell PowerEdge 15th generation servers: Com2

Table 40. Boot settings

Field Description Supported values Supported vendors

Set Boot Order Enable

Enables the boot option on the next boot for the list of Fully Qualified Device Descriptors (FQDDs).

For example:

Disk.Bay.22

NIC.PxeDevice.1-1

PCIeExtender.Slot.1

Dell

Set Boot Order Disabled

Disables the boot option on the next boot for the list of FQDDs. A boot device cannot be mentioned

in setBootOrderEn and setBootOrderDis simultaneously.

The devices that you specify in the boot order are specific to a server. To update the boot order in a hardware profile, you must have the same boot devices on all the servers.

Set Boot Order Fqdd1

Specifies a list of FQDDs representing the boot list to be applied on the next boot.

The system attempts to boot devices starting with the first item in the boot order. If the boot attempt fails, the system goes to the next item in the boot order. It repeats this process until the boot is successful or no more boot options are found.

Set Boot Order Fqdd2

Set Boot Order Fqdd3

Set Boot Order Fqdd4

Deployment 61

Table 40. Boot settings (continued)

Field Description Supported values Supported vendors

Set Legacy Hdd Order Fqdd1

Specifies a list of legacy hard drives to apply on the next boot. These settings are only applicable when the boot mode is set to BIOS.

For example:

RAID.Integrated.1-1

RAID.*.*

*.*.*

Dell

Set Legacy Hdd Order Fqdd2

Boot Mode Selects the boot mode for installing the operating system.

The BIOS boot mode is the legacy boot mode. It enables compatibility with older operating systems that do not support Unified Extensible Firmware Interface (UEFI).

UEFI boot mode is an interface between operating systems and platform firmware. It supports drive partitions greater than 2 TB, provides enhanced security, and faster boot time.

NOTE: If the operating system is not installed using the same boot mode, switching the boot mode may prevent the system from booting.

BIOS or UEFI Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model DL325 only.

Hard Disk Failover Enables or disables hard disk failover on an HA configuration.

Enabled

Disabled

Read-only field if Boot Mode is set to UEFI.

Dell

Boot Sequence Retry

Enables or disables the Boot Sequence Retry feature or resets the system. If the last attempt to boot has failed, the system immediately performs a cold reset, or retries to boot after a 30 sec. time-out period. This action depends on whether this field is set to Reset or Enabled.

Reset

Enabled

Disabled

Dell

HPE iLO

One-Time Boot Enables the boot device list from which a boot device can be selected. After you select the One-Time Boot Device List, you must select the required boot device from the corresponding Sequence Device field. The system attempts to boot once to the selected device on the next startup.

Disabled

UEFI Boot Sequence Device

BIOS Boot Sequence Device

BIOS Hard Disk Drive Sequence Device

Dell

Table 41. System profile settings

Field Description Supported values Supported vendors

System Profile Sets the System Profile to Performance Per Watt (DAPC), Performance Per Watt (OS), Performance, Workstation Performance, or Custom mode.

When set to a mode other than Custom, BIOS sets each option accordingly.

When set to Custom, you can change the setting of each option. Under Custom mode when C state is enabled, Monitor/Mwait should also be enabled.

Performance Per Watt (DAPC)

Performance Per Watt (OS)

Performance

Workstation Performance

Custom

Dell

Turbo Boost Turbo boost allows the processor cores to automatically enhance frequency beyond the advertised processor speed.

Enabled or Disabled

62 Deployment

Table 41. System profile settings (continued)

Field Description Supported values Supported vendors

This field enables or disables the processor to operate in the turbo boost mode.

C1E Enables or disables the processor to switch to a minimum performance state when it is idle.

Write Data CRC Enables or disables the Write Data CRC.

Workload Profile Optimizes performance that is based on the workload type. The Workload Profile setting is not a state. Setting a workload profile is a one-time action that in turn modifies various BIOS settings to be optimized for the requested workload type.

Valid values depend on the BIOS version.

NOTE: Some telco-related settings may appear as read-only. To configure these settings, select Telco Optimized Profile as the Workload

Profile.

Not Configured

HPC Profile

Low Latency Optimized Profile

Virtualization Optimized Performance Profile

Virtualization Optimized Performance Per Watt Profile

DataBase Optimized Performance Profile

Database Optimized Performance Per Watt Profile

SDS Optimized Performance Profile

SDS Optimized Performance Per Watt Profile

Telco Optimized Profile

Dell

HPE iLO

NOTE: Supported for HPE model DL325 only.

CPU Power Management

Enables selection of CPU power management methodology.

System DBPM (Demand-based Power Management) uses a BIOS-controlled dynamic frequency manipulation scheme. This saves power across various utilization levels as part of the Dell Advanced Power Control (DAPC) capability.

OS DBPM is a performance-per-watt option that relies on the operating system to dynamically control individual core frequency. Both Windows and Linux can take advantage of this mode to reduce frequency of idled or underutilized cores to save power.

Maximum Performance is typically selected for performance-centric workloads where it is acceptable to consume additional power to achieve the highest possible performance for the computing environment. This mode drives processor frequency to the maximum across all cores and is recommended for latency-sensitive environments.

System DBPM (DAPC)

OS DBPM

Maximum Performance

Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model DL325 only.

C States Enables or disables the processor to operate in all available power states.

NOTE: When set to Enabled or Autonomous,

it may cause an increase in the memory latency and frequency jitter.

Enabled

Disabled

Autonomous

Deployment 63

Table 41. System profile settings (continued)

Field Description Supported values Supported vendors

Memory Patrol Scrub

Patrol Scrubbing searches the memory for errors and repairs any correctable errors to prevent the accumulation of memory errors.

This field sets the memory patrol scrub frequency.

When set to Extended, the entire memory array is scrubbed frequently to further increase system reliability.

When set to Standard, the entire memory array is scrubbed once in a 24-hour period.

When set to Disabled, no patrol scrubbing occurs.

Extended

Standard

Disabled

Memory Refresh Rate

The memory controller periodically refreshes the data in the memory.

When set to 1x, it indicates the frequency at which memory is refreshed.

Use 2x when memory modules are operating at a higher than normal temperature, or to further increase system reliability.

CAUTION: Setting the refresh rate to 2x may have a negative impact on the memory subsystem performance.

1x or 2x

Memory Frequency Enables selection of the system memory speed. CAUTION: Reducing the memory frequency saves power but reduces performance.

Maximum Performance

3200 MHz

2933 MHz

2666 MHz

2400 MHz

2133 MHz

1866 MHz

Maximum Reliability

Dell

Supermicro

HPE iLO

Uncore Frequency Enables you to select the processor Uncore Frequency.

When set to Dynamic, the processor can optimize power resources across the cores and uncore during runtime.

Dynamic or Maximum Dell

Energy Efficient Policy

Enables you to select the energy-efficient policy.

The CPU uses this setting to manipulate the internal behavior of the processor and targets higher performance or better power savings.

Performance

Balanced Performance

Balanced Energy

Energy Efficient

Dell

Supermicro

Number of Turbo Boost Enabled Cores for Processor 1

Controls the number of turbo boost enabled cores for the processor. This value is automatically set to All when the value provided exceeds the number of cores available in the processor.

NOTE: You can only update this field if Turbo Boost is Enabled, and CPU Power

Management is set to Max Performance.

All, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, 26, 28

Dell

Number of Turbo Boost Enabled Cores for Processor 2

64 Deployment

Table 41. System profile settings (continued)

Field Description Supported values Supported vendors

Monitor/Mwait Enables or disables the Monitor/Mwait instructions in the processor.

NOTE: This setting is a read-only field when C States are set to Enabled.

Enabled or Disabled Dell

CPU Interconnect Bus Link Power Management

Enables or disables the CPU Interconnect Bus Link Power Management.

CAUTION: When Enabled, the CPU

Interconnect Bus Link Power Management can slightly reduce the overall system power and performance.

Enabled or Disabled

PCI ASPM L1 Link Power Management

Enables or disables the PCI Advanced State Power Management (ASPM) L1 Link Power Management.

Setting to Enabled slightly reduces overall system power and performance.

CAUTION: Some devices may stop responding or cause the system to stop responding when ASPM is enabled. For this reason, ASPM is enabled only for validated qualified cards.

Enabled or Disabled

Power and System Criteria for Package C State

Enables or disables the power and system criteria for a Package C state.

Enabled or Disabled

OS ACPI Cx Sets the OS ACPI Cx to C2 or C3 state. OsCxC2

OsCxC3

Package C State Latency Negotiation

Controls the Package C State latency negotiation when Package C States are Enabled.

Enabled or Disabled

GPSS Timer Allows the reduction of the GPSS timer to be set from 0-500us (typical value is 500us).

For XR11: 0us - 500us

CPU C1 Auto Demotion

Allows the CPU core to automatically demote to lower core idle states, when enabled.

Enabled or Disabled Dell

CPU C1 Auto UnDemotion

Allows the CPU to automatically undemote from demoted C1 state, when enabled.

Workload Configuration

Controls the BIOS settings for energy performance, which enables the BIOS to select a configuration that improves the performance on a specific workload.

Dependent on the workload profile selected

CPU Interconnect Bus Speed

Sets the frequency of the communication links among the CPUs in the system.

Maximum Data Rate indicates that the BIOS runs the communication links at the maximum frequency that the processors support.

Maximum Data Rate

AC Power Recovery

Controls the system behavior after a power failure event. Set to On for the system to turn on after AC

power is restored. Set to Off for the system to stay off after AC

power is restored.

On

Off

Last

Dell

HPE iLO

Deployment 65

Table 41. System profile settings (continued)

Field Description Supported values Supported vendors

Set to Last for the system to turn on if the system was on when AC power was lost. The system remains off if the system was turned off when AC power was lost. If an ungraceful shutdown occurs, the system always turns on.

Table 42. System security settings

Attribute Description Supported Values Supported vendors

TPM Security Controls the reporting of the Trusted Platform Module (TPM) in the system. When set to On, the presence of the TPM is

reported to the OS. When set to Off, the presence of the TPM is not

reported to the OS.

NOTE: Found Only in XR models, Dell PowerEdge 14th generation servers and Dell PowerEdge 15th generation servers are read- only.

For Dell servers:

On

Off

For Supermicro servers:

Enable Disable: Set to Disable

to onboard a Supermicro server.

Dell

Supermicro

Power Button Enables or disables the power button on the front panel.

NOTE: For Supermicro, when the value is set to Instant Off, pressing the power button

causes the system to turn off immediately in a legacy operating system. When the value is set to 4 Seconds Override, pressing the power

button for 4 seconds causes the system to turn off. Make sure this value is set to onboard a Supermicro server.

For Dell servers:

Enabled or Disabled

For Supermicro servers:

4 Seconds Override Instant Off

Dell

Supermicro

HPE iLO

UEFI Variable Access

Provides varying degrees of securing UEFI variables. When set to Standard, UEFI variables are

accessible and can be modified in the Operating System (OS) per the UEFI specification.

When set to Controlled, select UEFI variables are protected, and cannot be modified in an OS environment. New UEFI boot entries are forced to be at the end of the current boot order.

Standard or Controlled Dell

HPE iLO

AC Power Recovery Delay

Allows staggering of power-up after AC power is restored to the system. When set to Immediate, there is no delay for

power-up. When set to Random, the system creates a

random delay for power-up. When set to User-Defined, the system delays

power-up by the user-defined amount. The user- defined power-up delay is defined in the User Defined Delay field.

Immediate

Random

User-Defined

CAUTION: You must set AC Power Recovery to

On before modifying this

attribute.

Dell

HPE iLO

NOTE: Supported for HPE model DL325 only.

Memory Encryption Allows enabling or disabling of the Intel Total Memory Encryption and Multi-Tenant (Intel TME-MT) for Dell PowerEdge 15th generation servers, XR11 and XR12 servers:

SingleKey

MultipleKeys

Disabled

Dell

66 Deployment

Table 42. System security settings (continued)

Attribute Description Supported Values Supported vendors

When set to Disable, BIOS disables both TME and TME-MT technology.

When set to Single Key, BIOS enables the TME technology.

When set to Multiple Keys, BIOS enables the TME-MT technology.

NOTE: Requires BIOS version 1.3.8 or higher

NOTE: This attribute is not supported in 14G servers. It is only supported in 15G servers, including XR11 and XR12.

User Defined Delay Controls the duration for which the power-on process is delayed after the AC power supply is restored. The value is only effective if the AC Power Recovery Delay is set to User-Defined.

60-600 s

Band Manageability Interface

Enables or disables the visibility of the Management Engine's (ME) HECI devices and the IPMI devices from the operating system.

Setting to Disabled prevents the operating system from changing the ME power capping settings, and blocks access to all in-band management tools. Out- of-band management tools handle this function.

Enabled or Disabled

Password Status Enables or disables the requirement for the system password to be changed with the use of the setup password. When set to Unlocked, the system password

can be changed without entering the setup password. This allows an administrator to maintain a setup password to protect against unauthorized BIOS Setup changes.

When set to Locked, the setup password must be entered to change the system password. This requires the setup password field to be Enabled.

Locked or Unlocked

Table 43. Memory settings

Field Description Supported values Supported vendors

System Memory Testing

Enables or disables the BIOS system memory tests during system boot.

NOTE: Enabling memory testing results in longer boot time. The extent of increased time depends on the size of the system memory.

Enabled or Disabled Dell

Supermicro

HPE iLO

Memory Operating Mode

Indicates the memory operating mode.

When Optimizer Mode is enabled, the DRAM controllers operate independently in 64-bit mode and provide optimized memory performance.

When Single Rank Spare Mode is enabled, the memory size that is reported to the operating system does not include the single rank spare portion.

Optimizer Mode

Single Rank Spare Mode

Mirror Mode

Fault Resilient Mode

Dell

Deployment 67

Table 43. Memory settings (continued)

Field Description Supported values Supported vendors

When Mirror Mode is enabled, the server maintains two identical copies of data in the memory. This allows the system to continue running even during a catastrophic memory failure.

When Fault Resilient Mode is enabled, part of the total installed memory is configured to create a fault-resilient zone. Select hypervisors use this zone for host virtualization resilience.

Node Interleaving Indicates if Non-Uniform Memory Architecture (NUMA) is supported.

When Enabled, the system supports memory interleaving when symmetric memory configuration is installed.

When Disabled, the system supports the NUMA asymmetric memory configuration.

NOTE: This is a read-only field when Sub NUMA Cluster is set to Enabled.

Enabled or Disabled Dell

Supermicro

Opportunistic Self- Refresh

Enables or disables the opportunistic self-refresh feature.

Enabled or Disabled Dell

HPE iLO

NOTE: Supported for HPE model e910t only.

Memory Training Selects the memory training configuration.

Fast: Uses previously saved memory training parameters to train the memory subsystem when memory configuration is not changed. System boot time is reduced when memory configurations are not changed. If memory configuration is changed, the system automatically enables \"Retrain at Next Boot\" to force one-time full memory training steps, and then goes back to \"Fast\" afterward.

Retrain at Next Boot: Forces one-time full memory training steps at the next system power on. System boot time is slowed on the next boot.

Enable: Forces full memory training steps on every system power-on. System boot time is slowed on every boot.

Fast

Retrain at Next Boot

MemoryTrainingEnable

Correctable Memory ECC SMI

Enables or disables the logging of Error Correction Code (ECC) into the Server Event Log (SEL).

NOTE: When Disabled, latency issues can be

avoided.

Enabled or Disabled Dell

DRAM Refresh Delay

Instructs the CPU memory controller to minimize the delay time. This ensures that the memory controller runs the refresh command at regular intervals.

Performance or Minimum

Correctable Error Logging

Enables or disables all LifeCycle/SEL logging that is related to correctable errors.

Enabled or Disabled

68 Deployment

Table 44. Processor settings

Field Description Supported values Supported vendor

Virtualization Technology

Enables or disables the virtualization technology for the processor.

NOTE: Disabling virtualization technology is not likely to alter the performance or power characteristics of the system, so leaving this option Enabled is recommended. If this

setting is Disabled, you must also disable

x2APIC Mode.

Enabled or Disabled Dell

Supermicro

Adjacent Cache Line Prefetch

When Enabled, this setting optimizes the system for applications that require high utilization of sequential memory access.

When Disabled, this setting optimizes the system for applications that require high utilization of random memory access.

Enabled or Disabled

Hardware Prefetcher

Enables or disables the hardware prefetcher.

When set to Enabled, the processor can prefetch extra cache lines for every memory request.

CAUTION: This setting can affect performance depending on the application running on the server and memory bandwidth utilization.

Enabled or Disabled

Logical Processor Enables or disables the logical processors and displays the number of logical processors. Each processor core supports up to two logical processors.

When Enabled, the BIOS reports all logical processors.

When Disabled, the BIOS reports only one logical processor per core.

Enabled or Disabled Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model e910t only.

Software Prefetcher

Enables or disables the software prefetcher.

When set to Enabled, the processor can prefetch extra cache lines for every memory request.

CAUTION: This setting can affect performance depending on the application running on the server and memory bandwidth utilization.

Enabled or Disabled Dell

DCU Streamer Prefetcher

Enables or disables Data Cache Unit (DCU) streamer prefetcher. Enabled is recommended only for high performance computing applications.

CAUTION: This setting can affect performance, depending on the application running on the server.

Enabled or Disabled Dell

Supermicro

DCU IP Prefetcher Enables or disables Data Cache Unit (DCU) IP prefetcher. Enabled is recommended only for high performance computing applications.

Enabled or Disabled

Deployment 69

Table 44. Processor settings (continued)

Field Description Supported values Supported vendor

CAUTION: This setting can affect performance, depending on the application running on the server.

Sub NUMA Cluster Enables or disables the Sub NUMA Clustering (SNC).

SNC is a feature for breaking up the Last-level Cache (LLC) into disjoint clusters. This action is based on address range, with each cluster bound to a subset of the memory controllers in the system. It improves average latency to the LLC.

NOTE: This is a read-only field when Node Interleaving is set to Enabled.

Enabled or Disabled

UPI Prefetch Enables or disables the start of early memory that is read on the DDR bus.

Enabled or Disabled Dell

Logical Processor Idling

Logical Processor Idling (LPI) is a collaborative interface between platform and operating system that helps in improving the energy efficiency of a system. LPI is required for power budgeting.

When set to Disabled, the operating system capability to put the logical processors in idling state is restricted.

NOTE: This is a read-only field when CPU Power Management is set to Maximum Performance.

Enabled or Disabled

x2APIC Mode Enables or disable the x2APIC mode. NOTE: This is a read-only field when Virtualization Technology is Disabled.

Enabled or Disabled Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model DL325 only.

Number of Cores per Processor

Controls the number of enabled cores in each processor.

NOTE: You may see limited performance improvements to Boost Technology and benefit from potentially larger shared caches by reducing the number of enabled cores. However, most computing environments benefit from a larger number of processing cores. Carefully consider whether you can gain nominal performance enhancements by disabling cores.

All, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22

Dell

Supermicro

AVX ICCP Pre- Grant License

Enables or disables the AVX ICCP Pre-Grant License.

NOTE: This attribute is not available for Dell PowerEdge 14th generation servers.

Enabled or Disabled Dell

70 Deployment

Table 44. Processor settings (continued)

Field Description Supported values Supported vendor

AVX ICCP Pre- Grant Level

When the AVX License Pre-Grant attribute is Enabled, you can use this option to select the AVX ICCP Pre-Grant license level.

NOTE: Supported on only Dell PowerEdge 15th generation servers. This attribute is not available for Dell PowerEdge 14th generation servers.

IccpHeavy128

256 Light

256 Heavy

512 Light

512 Heavy

LLC Prefetch Enables or disables Last Level Cache Prefetch on all threads.

Enabled or Disabled Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model e910t only.

AVX P1 Selects the AVX P1 level. Normal

Level1

Level2

Intel SST-CP (Intel Speed Select Technology Core Power)

Use this interface to define priority per core. This mechanism distributes power across cores for a scenario with power constraints.

Enabled or Disabled Dell

Directory Mode Enables or disables directory mode. Enabled or Disabled

MADT Core Enumeration

Determines how BIOS enumerates processor cores in the ACPI MADT table.

Round Robin: processor cores are enumerated in a Round Robin order to evenly distribute interrupt controllers for the OS across all Sockets and Dies.

Linear: processor cores are enumerated across all Dies within a Socket before enumerating additional Sockets for a linear distribution of interrupt controllers for the OS.

Round Robin or Linear

XPT Prefetch A mechanism that enables the MS2IDI to take a read request that is being sent to the LLC and speculatively issues a copy of that read to the memory controller. Enabled is the default setting.

Enabled or Disabled

DeadLine LLC Allocation

Enables or disables the filling of deadlines in LLC. Enabled or Disabled Dell

HPE iLO

NOTE: Supported for HPE model e910t only.

Directory AtoS Enables or disables AtoS optimization, which reduces remote read latencies for repeat read accesses without intervening writes.

Enabled or Disabled

Dell Controlled Turbo

Enables or disables the turbo engagement feature. It is active when:

System Profile is set to Performance.

System Profile is set to Custom, CPU Power Management is set to Maximum Performance, and Turbo Boost is Enabled.

Enabled

Disabled

Controlled Turbo Limit Minus 1

Controlled Turbo Limit Minus 2

Controlled Turbo Limit Minus 3

Dell

Deployment 71

Table 44. Processor settings (continued)

Field Description Supported values Supported vendor

Optimizer Mode Determines the optimization of the CPU Performance.

Auto: Enabled when CPU Power Management is set to Max Performance.

Enabled: Enabled regardless of the CPU Power Management setting selected.

Disabled: Turns off the feature.

Auto

Enabled

Disabled

Table 45. Serial communication

Field Description Supported values Supported vendors

Serial Communication

Enables you to select serial communication devices in BIOS.

On without Console Redirection

Auto

On with Console Redirection using COM1

On with Console Redirection using COM2

Off

Dell

External Serial Connector

Enables you to associate the External Serial Connector to Serial Device 1, Serial Device 2, or the Remote Access Device.

Serial Device 1

Serial Device 2

Remote Access Device

Serial Port Address Enables you to set the port address for the serial devices.

NOTE: Only Serial Device 2 can be used

for Serial Over LAN (SOL). To get Console Redirection over SOL, configure the same port address for Console Redirection and Serial Device.

Serial Device1=COM1

Serial Device2=COM2 and Serial Device1=COM2

Serial Device2=COM1

Dell

Supermicro

HPE iLO

NOTE: Supported for HPE model e910t only.

Failsafe Baud Rate Specify the failsafe baud rate for console redirection.

If the BIOS fails to determine the baud rate automatically, the baud rate that is specified in this field is used.

115200, 57600, 19200, or 9600 Dell

HPE iLO

Remote Terminal Type

Sets the terminal type for your remote console. VT100/VT200 or ANSI

Redirection After Boot

Enables or disables the BIOS console redirection when the operating system is loaded.

Enabled or Disabled

Table 46. Integrated devices

Field Description Supported values Supported vendors

SR-IOV Global Enable

Enables or disables the BIOS configuration of SR- IOV devices.

When Enabled, booting to a virtualization operating system recognizes SR-IOV devices.

Enabled or Disabled Dell

Supermicro

HPE iLO

72 Deployment

Table 46. Integrated devices (continued)

Field Description Supported values Supported vendors

NOTE: Supported for HPE model DL325 only.

Embedded Video Controller

Enables or disables the use of the Embedded Video Controller as the primary display. This feature is available in all models. When set to Enabled, the Embedded Video

Controller is the primary display even if add-in graphics cards are installed.

When set to Disabled, an add-in graphics card is used as the primary display. BIOS sends displays to both the primary add-in video and the embedded video during POST and pre-boot environment. The embedded video is then disabled before the operating system boots.

NOTE: If multiple add-in graphics cards are installed in the system, the first card that is discovered during PCI enumeration is selected as the primary video. You may have to rearrange the cards in the slots to control which card is the primary video controller.

Enabled or Disabled Dell

HPE iLO

NOTE: Supported for HPE model DL325 only.

Memory Mapped I/O above 4 GB

Enables or disables the allocation of PCI/PCIe MMIO to address space above 4GB.

Enabled or Disabled Dell

Supermicro

User Accessible USB Ports

Configure the User Accessible USB Ports. Only Back Ports On disables the front USB

ports; All Ports Off disables all front and back USB

ports All Ports Off (Dynamic) disables all front

and back USB ports during the POST. An authorized user can dynamically enable or disable the front ports without resetting the system.

NOTE: When set to All Off Dynamic, USB Enable Front Ports Only is hidden.

The USB keyboard and mouse still function in certain USB ports during the boot process, depending on the selection. After the boot process is complete, the USB ports are enabled or disabled as per the setting.

All On

Only Back Ports On

All Off

All Off Dynamic

Dell

HPE iLO

Internal USB Port Enables or disables the internal USB port. On

Off

On all servers

Dell

Direct USB Port The Direct USB port manages iDRAC exclusively with no host visibility. When set to Off, iDRAC would not detect any USB devices that are installed in this managed port.

On

Off

Deployment 73

Table 46. Integrated devices (continued)

Field Description Supported values Supported vendors

I/OAT DMA Engine Enables or disables the I/O Acceleration Technology (I/OAT).

I/OAT are DMA features designed to accelerate network traffic and lower CPU usage.

NOTE: This feature should be enabled only if the hardware and software support I/OAT.

Enabled or Disabled

I/O Snoop Hold Off Response

Selects the number of cycles PCI I/O can withhold snoop requests, from the CPU, to allow time to complete its own write to LLC.

This setting can help improve performance on workloads where throughput and latency are critical.

On Dell PowerEdge 14th generation servers, only values up to Roll 2K Cycles are valid.

Roll 256 Cycles

Roll 512 Cycles

Roll 1K Cycles

Roll 2K Cycles

Roll 4K Cycles

Roll 8K Cycles

Roll 16K Cycles

Roll 32K Cycles

Roll 64K Cycles

Roll 128K Cycles

OS Watchdog Timer If the system stops responding, this watchdog timer helps in the recovery of your operating system (OS). This feature is available in all models. When set to Enabled, the OS is allowed to

initialize the timer. When it is set to Disabled, the timer has no

effect on the system.

Enabled or Disabled

Empty Slot Unhide If set to Enabled, root ports of all the empty slots are accessible to the BIOS and OS. This feature is available in all models.

Enabled or Disabled

Slot Bifurcation - Auto Discovery Bifurcation Settings

Allows the BIOS to dynamically scan for PCIe devices rather than relying strictly on system slot definitions.

Platform Default strictly follows the system slot definitions when configuring each PCIe slot.

Auto Discovery analyzes the installed PCIe cards and determines the correct slot configuration. This may include slot bifurcation for multiple devices.

Manual Control allows you to override bifurcation settings for each slot.

CAUTION: Improper configuration of PCIe slots can prevent the system from functioning properly.

Platform Default

Auto Discovery

Manual Control

Slot bifurcation depends on this attribute (becomes read-only).

Slot Disablement - Slot 1

Controls the configuration of PCIe cards that are installed in the specified slot. Slot disablement must be used only when the installed peripheral card is preventing booting into the operating system or causing delays or lockups in system startup.

Enabled

Disabled

Boot Driver Disabled

Dell

HPE iLO

NOTE: Supported for HPE

74 Deployment

Table 46. Integrated devices (continued)

Field Description Supported values Supported vendors

When set to Disabled, both the Option ROM and UEFI driver are disabled, the card is not enumerated on the PCI bus and is not available to the operating system.

When set to Boot Driver Disabled, the Option ROM and UEFI driver from that slot does not run during POST. As a result, the system does not boot from the card, and its pre-boot services are not available. However, the card is available to the operating system.

NOTE: This option is not available if the slot contains a Dell PowerEdge RAID card (PERC).

NOTE: Some PCIe device manufacturers implement a main boot driver that can initialize and manage all similar devices in the system. To ensure that the Option ROM and UEFI driver do not run, select Boot Driver Disabled for all cards from the same manufacturer (including its integrated device versions such as NDCs).

model DL325 only.

Slot Disablement - Slot 2, Slot 3

Controls the configuration of PCIe cards that are installed in the specified slot. Slot disablement must be used only when the installed peripheral card is preventing booting into the operating system or causing delays or lockups in system startup. When set to Disabled, both the Option ROM

and UEFI driver are disabled, the card is not enumerated on the PCI bus and is not available to the operating system.

When set to Boot Driver Disabled, the Option ROM and UEFI driver from that slot does not run during POST. As a result, the system does not boot from the card, and its pre-boot services are not available. However, the card is available to the operating system.

NOTE: This option is not available if the slot contains a Dell PowerEdge RAID card (PERC).

NOTE: Some PCIe device manufacturers implement a main boot driver that can initialize and manage all similar devices in the system. To ensure that the Option ROM and UEFI driver do not run, you must select Boot Driver Disabled for all cards from the same manufacturer (including its integrated device versions such as NDCs).

Enabled

Disabled

Boot Driver Disabled

Dell

Table 47. Network settings

Attribute Description Supported values Supported vendors

PXE Device 1 Enables or disables the device for PXE Boot selection.

Enabled or Disabled Dell

Supermicro

Deployment 75

Table 47. Network settings (continued)

Attribute Description Supported values Supported vendors

PXE Device 2 NOTE: Only PXE Device 1 is supported for Supermicro

Dell

PXE Device 3

PXE Device 4

PXE Device 1 Interface

Specifies the interface that is used for each device. The interface value can be changed only if the device is enabled.

For Supermicro servers, the PXE Device 1 Interface specifies the NIC interface that is used for PXE boot. For Supermicro, the bootMode attribute is supported for both Uefi and Bios mode.

NOTE: Only PXE Device 1 Interface is supported for Supermicro

Available NIC Ports. For example:

NIC.Integrated.1-1

Dell

Supermicro

PXE Device 2 Interface

Dell

PXE Device 3 Interface

PXE Device 4 Interface

Table 48. SATA settings

Attribute Description Supported Values Supported vendors

SATA-Embedded SATA

Determines the mode of the Embedded SATA. ACHIMode

RAIDMode

Off

Dell

SATA-Write Cache Sends Enable or Disable Write Cache commands to the Embedded SATA drives during POST.

NOTE: This option only applies to AHCI mode.

Enabled or Disabled

SATA-Security Freeze Lock

Sends the Security Freeze Lock command to the Embedded SATA drives during POST.

NOTE: This option only applies to AHCI mode.

Enabled or Disabled Dell

HPE iLO

NOTE: Supported for HPE model DL325 only.

Table 49. Redundant OS Control

Attribute Description Supported Values Supported vendors

Redundant OS Location

Specifies the backup device for the Redundant OS Control feature. When Redundant OS Boot is set to Enabled, the BIOS boots to this device.

1. SD Card Port, Internal USB Port, M.2 cards: If a device is set as the Redundant OS Location, then the corresponding device setting is set based on Redundant OS state and is not available to be changed in Integrated Devices.

2. Embedded SATA: Set to anything other than Off for SATA ports to show up as optional backup devices.

SATA Port A

SATA Port B

NONE

Dell

76 Deployment

Table 50. Miscellaneous settings

Attribute Description Supported values Supported vendors

F1/F2 Prompt on Error

Determines whether the BIOS stops and displays a prompt when certain types of errors occur during POST. When Enabled, the BIOS displays the

prompt. When Disabled, the BIOS continues through

POST and attempts to boot an operating system.

Enabled or Disabled Dell

HPE iLO

Keyboard Number Lock

Determines whether the system boots with Num Lock enabled or disabled. This does not apply to 84-key keyboards. When On, the far right keys on the keyboard

function like those on a numeric calculator. When Off, they function as cursor-control

keys.

On or Off Dell

Dell Wyse P25/P45 BIOS Access

Enables or disables Remote user to access BIOS Setup using the Dell Wyse P25/P45 Portal.

If P25/P45 BIOS Access is turned off, it cannot be turned back on remotely from the P25/P45. Turning this feature off also prevents keyboard and mouse access to Diagnostics, Boot Options, and other Pre-OS functionality.

Enabled or Disabled

Power Cycle Request

Specifies how the system reacts when the system transitions to S5 state. When set to None, the transition to S5 is

normal. When set to Full Power Cycle, the system is

temporarily forced into a lower power state that resembles removing and replacing AC.

None or FullPowerCycle

Load Legacy Video Option ROM

In UEFI Boot Mode, this field determines whether the system BIOS loads the legacy video (INT 10h) option ROM from the video controller.

This may be required to install older Operating Systems. Setting this field to Enable may fix the OS installation issue of a blank screen.

This field has no effect when Boot Mode is set to BIOS. This field cannot be set to Enabled when Boot Mode is UEFI and Secure Boot is enabled.

Enabled or Disabled Dell

HPE iLO

NOTE: Supported for HPE model DL325 only.

BMC settings

The BMC settings are grouped under the following menus:

DNS SettingsConfigures the DNS server for the BMC to use. NTP SettingsConfigures the NTP servers for the BMC to use. ConnectivityConfigures network settings and settings to establish internal communication channels. ServicesConfigures the SNMP settings and time zone. BMC UsersSpecifies the user accounts to create, update, or delete. To view the list of all BMC users on a server, go to

Inventory > View Device > View: Configuration > BMC Users.

Click the menus to view the fields and update the values. The following tables describe the BMC settings and their supported values.

Deployment 77

NOTE: The Finish button is enabled only after you navigate through all the menus.

A short list of BMC attributes is supported for operating system deployments:

rfsIgnoreCertWarning serialRedirectEnable

Table 51. DNS settings

Field Description Supported values Supported vendors

Use DHCP to Obtain DNS Server Addresses

Use Dynamic Host Configuration Protocol (DHCP) to assign the DNS server IP address.

Enabled or Disabled Dell

Static Preferred DNS Server

IP address of the DNS server. You can configure up to two DNS servers.

NOTE: These settings are disabled if Use DHCP to Obtain DNS Server Addresses is Enabled.

NOTE: For Supermicro, you must only configure one DNS server.

For example, 11.11.11.11

Dell

Supermicro

HPE iLOStatic Alternate DNS Server

Static DNS Domain Name

DNS Domain Name NOTE: A reset is required after changing this setting.

For example:

dell.com

DNS RAC Name The name of the server. The default format is SERVER- .

NOTE: A reset is required after changing this setting.

For example:

SERVER-D2T5MH3

Table 52. NTP settings

Field Description Supported values Supported vendors

Enable Network Time Protocol (NTP)

Enables or disables the use of NTP by the BMC.

NOTE:

NOTE: This configuration overwrites the existing NTP configuration.

Enabled or Disabled Dell

Supermicro

HPE iLO

NTP Server 1 - 3 IP address of the NTP server. You can configure up to three NTP servers.

NOTE: For HPE iLO servers, set the Enable Network Time Protocol attribute to Enabled to enable the

supported NTP servers. You can configure a maximum of two NTP servers for HPE iLO and Supermicro servers.

For example, 10.10.10.10

Table 53. Connectivity settings

Field Description Supported values Supported vendors

Topology LLDP Enables or disables the Link Layer Discovery Protocol (LLDP) topology information.

Enabled or Disabled Dell

Pass-through Configuration State

Enables or disables the administrative state of the IMC.

Enable IPMI Over LAN

Enables or disables the Intelligent Platform Management Interface (IPMI) over the

Dell

78 Deployment

Table 53. Connectivity settings (continued)

Field Description Supported values Supported vendors

baseboard management controller's (BMC) LAN interface.

HPE iLO

Enable VLAN ID Enables or disables the Virtual Local Area Network (vLAN) capabilities of the BMC.

NOTE: A reset is required after changing this setting.

VLAN ID Specifies the VLAN ID for the network VLAN configuration.

CAUTION: Changing this field may result in losing BMC access and impacting network connectivity.

NOTE: A reset is required after changing this setting.

1 to 4094

Virtual Console Plug- in Type

The type of browser plug-in to use to remotely access a BMC.

To update this attribute on Supermicro servers, the virtual console needs to be disabled first. The virtual console plug-in type cannot be changed when there is an active virtual console session.

NOTE: For Supermicro servers, the supported values are Java or HTML5.

ActiveX, Java, HTML5, or eHTML5.

Dell

Supermicro

Serial Redirect Enables or Disables the console for COM2 port redirection.

Enabled or Disabled Dell

RFS Ignore Cert Warning

Ignore the certificate warning message. Yes or No

Table 54. Services settings

Field Description Supported values Supported vendors

SNMP Agent Enabled Enables or disables the Simple Network Management Protocol (SNMP) agent on the BMC.

Enabled or Disabled Dell

HPE iLO

SNMP Community Name

Specifies the SNMP community name to use for SNMP agents. The name can have up to 31 nonblank characters.

NOTE: Set the SNMP Protocol attribute to All before making changes to the SNMP Community Name attribute.

For example, public

SNMP Protocol SNMP protocol. NOTE: Set the SNMP Agent Enabled to Enabled before changing the SNMP Protocol attribute.

All or SNMPv3

SNMP Discovery Port Number

SNMP agent port on the BMC. NOTE: Set the SNMP Agent Enabled to Enabled before changing the SNMP Discovery Port Number attribute.

1 to 65535, except 22, 80, and 443.

Deployment 79

Table 54. Services settings (continued)

Field Description Supported values Supported vendors

Time Zone Select the time zone from the drop-down list.

NOTE: A reset is required after this setting is changed.

For example, US/ Central, Universal, and so on.

Dell

Supermicro

HPE iLO

Table 55. BMC users settings

Field Description Supported values Supported vendors

User Name Specifies the username of a user that you are creating or updating.

NOTE: Must be a valid BMC username. Special characters cannot be entered in the username.

For example, Root. Dell

Supermicro

HPE iLO

Password Specifies the password of the user.

Role Specifies a user role. Options are: None Administrator Read Only Operator

iDRAC example:

Administrator

Operator

Read Only

None

Enabled Enables or disables the user.

Check this box to enable the user. Clear it to disable the user.

True or False Dell

Create Users, Update Users The (plus) and (minus) icons

builds a list of users to create or update.

adds a user to the list.

removes the corresponding user from the list.

Delete Users

The (plus) and (minus) icons builds a list of users to be deleted.

adds a user that you want to delete to the list.

removes the corresponding user from the list.

NOTE: An Administrator account can be deleted only if another Administrator account exists.

80 Deployment

RAID settings

Specify RAID storage options for Dell PowerEdge and HPE iLO servers.

Steps

1. In the RAID Settings dialog box, select Create in the Actions drop-down list.

2. Complete these fields as required:

Table 56. RAID settings

Field Description Supported values

Name Descriptive name for the RAID volume. Any meaningful name.

Software RAID (SWRAID)

Configures RAID settings through software.

For HPE iLO servers, only hardware RAID controllers are supported. Set this value to NO for HPE iLO servers.

Optional values are YES|NO. If set to YES, set RAID type to RAID 1.

RAID Type The type of RAID volume to create. RAID 0, RAID 1, RAID 5, or RAID 10

Media Type The type of media to use for the RAID volume. Solid-state drive (SSD) or hard disk drive (HDD).

Capacity (Bytes) The minimum and maximum size of the hard drives to use for the RAID volume.

Enter the minimum and maximum hard drive size to use for creating the RAID volume in the Capacity (Bytes) field.

Number of Drives The number of hard drives to use when creating the RAID volume.

Valid values depend on the selected RAID type.

3. Click Save to create the RAID configuration.

4. Optional: Select Delete Non-Matching Volumes to automatically delete non-matching RAID volumes.

CAUTION: This is a destructive operation that can result in data loss.

When you create a RAID volume, you name the volume, and that name is written to the volume metadata. If Bare Metal Orchestrator finds a volume with a name that is not in the RAID configuration, and then deletes the volume.

NOTE: The default is to retain (not delete) RAID volumes.

Results

You can edit or delete a RAID configuration after you create it. NOTE: The RAID controller can be in either Enhanced HBA (eHBA) mode or RAID mode. RAID mode is required to create

RAID volumes. If the RAID controller is in eHBA mode, it is automatically switched to RAID mode.

Operating system settings

The following tables list user-configurable settings for supported operating systems that you can deploy on one or more Dell PowerEdge or HPE iLO servers using a hardware profile.

NOTE: HPE iLO servers support Ubuntu 18.04 LTS and 20.04 LTS operating systems.

You can edit these YAML file attributes with the web UI.

Common operating system attribute settings. Configurable ESXi operating system settings. Configurable openSUSE operating system settings. Configurable Red Hat Enterprise Linux operating system settings. Configurable Ubuntu 18.04 LTS and 20.04 LTS operating system settings. Wind River Cloud Platform operating system settings.

Deployment 81

NOTE: Before you can edit operating system settings in the hardware profile, the media must be created. For more

information, see Deploy an operating system.

The following table lists common operating system YAML attributes that you can configure when deploying any operating system on a server.

Table 57. Common operating system attribute settings

Field Description Supported values

operatingsystemname The name of the operating system media.

This name must match the metadata name value in the media object.

For ESXi, updating this field initiates an operating system version upgrade.

Examples:

esxi7.0.3

rhel8.4

suse15.3

ubuntu18.04

ubuntu20.04

wrmedia

overwriteInstallation Optional attribute used to overwrite the existing operating system that is installed on the server when you perform an operating system upgrade.

NOTE: For Ubuntu OS, the value is always true.

true or false

operatingsystemconfig

autoConfigureBoss Optional: Creates and configures a RAID 1 volume in BOSS cards for an OS install if the original volume is deleted or does not exist. The newly created volume is used to install and boot the OS. Set the value to true to store the OS install on the RAID 1 volume.

true or false

networkingDetails Optional attribute used to set a specific hostname for a server.

Updating the hostname value sets the hostname for the operating system on the server. This value is applied only when the OS installation is run on the server.

Make sure each hostname is unique and is configured on each server separately before installing an OS with a hardware profile.

NOTE: The networkingDetails field must be configured through the server profile only.

Examples:

esxi-hostname

rhel-hostname

suse-hostname

ubuntu-hostname

wr-hostname

ntpServer Specifies a list of NTP server names or serverIPv4 IP address for ESXi operating system. You can configure up to three NTP servers.

NOTE: Not supported for Ubuntu OS.

A valid IP address or server name

dnsSearch The local domain name which is affixed to a name that is not qualified. For example, if the DNS search domain is set to dell.com, and the name to be resolved is www, then the system searches for www.dell.com.

NOTE: Not supported for Ubuntu OS.

For example:

www.dell.com

dnsServer Specifies a list of DNS serverIPv4 IP address for ESXi operating system.

A valid IP address

installVolumeID The FQDD identifier of the RAID, Host Bus Adapter (HBA), SD card inventory, or NVM Express (NVMe) volume to install the operating system on.

Example:

For RAID: Disk.Virtual.0:RAID.Slot.2-1

82 Deployment

Table 57. Common operating system attribute settings (continued)

Field Description Supported values

Updating the installVolumeID in a hardware profile requires that the volume must have the same identifier available on all servers that the profile targets.

Optional field: If no value is specified, the system selects a volume for installing an operating system from the installVolumeTypeOrder field.

For SD card inventory: Disk.SDInternal.1

installVolumeTypeOrder Specify the order in which the volume type is selected for operating system installation.

The system checks the volumes starting with the first volume type. If the volume type is present on the server, the operating system is installed on that volume. If that volume type does not exist on the server, the next type is checked.

Optional field: If no value is specified, the system selects the volume for installing an operating system from the installVolumeID field.

For HBA, SDCARD, NVME and BOSS, the first volume name of that type that displays in the storage field of the status section is selected for operating system installation.

For RAID, you can specify the volume name. It must match the value set for the attribute name in the raidVolumes.

Delete all RAID volumes available on the server where the operating system was previously deployed if: an operating system is deployed on a specific RAID

volume. you want to install the operating system on a different

RAID volume.

You can now install the operating system on the new RAID volume.

For example, suppose that an operating system is deployed on RAID Volume1, and you want to install the operating system on RAID Volume2. You must delete all RAID volumes that are used for the operating system installation. You can then perform operating system deployment on RAID Volume2.

NOTE: If a server does not have any storage controllers or volumes, the ESXi OS installation installs onto the default hard drive.

SDCARD

NVME

RAID

HBA

BOSS

The following table lists only the configurable ESXi-specific operating system YAML attributes.

Table 58. ESXi-specific operating system settings

Field Description Supported values

operatingsystemconfig

configtype Operating system configuration type. The Preseed file contains configurations that are required for operating system installation.

preseed

osDriver The name of the device driver media files. Examples:

icen-media

ibbd-media

intnet-media

Preseed configdata settings

Deployment 83

Table 58. ESXi-specific operating system settings (continued)

Field Description Supported values

configdata Use the sample preseed configdata and update the following attributes.

For information about preseed file commands, see Installation and Upgrade Script Commands in the VMware vSphere Product Documentation for VMware vSphere 6.7.

NOTE: The blank lines between each command in the configdata section are required for successful operating system deployment.

See the sample preseed configdata.

rootpw Enter the host operating system password for root user. This is a user-supplied value.

network Add server network information where you are installing the operating system.

--bootproto: specify whether to obtain the network settings from DHCP or set them manually. The supported values are dhcp or static.

NOTE: For PXE boot, the bootproto must be set to dhcp.

The following fields are required if bootproto is set to static:

ip IP address of the server

gateway Default gateway IP address

netmask Subnet mask of the server

nameserver IP address of the DNS server. Omit this option if you do not intend to use a DNS server

vlanid The VLAN the server is on.

--device: specify the MAC address of either the network card or the server. For example: A0:12:10:00:C0:D3

--hostname: ESXi hostname. For example: esxi1.dell.com. This is an optional field.

Set bootproto to dhcp when using a hardware profile to configure the network attributes. Only one network entry is needed to install the operating system on multiple servers using a hardware profile.

Set bootproto to either static or dhcp when using a server YAML file to configure the network attributes. If the server has one or more NICs with multiple networking ports to set up, add separate network entries for each on separate lines in the server YAML file. Include the device attribute. Specify the MAC address of the NIC that you are setting up, which is from the BMC settings. The first NIC is used by default if the device attribute is omitted.

The following table lists only the configurable openSUSE-specific operating system attributes.

NOTE: The autoyast configdata section contains XML code. In the table, XML formatting is omitted and elements are

listed by name. However, some examples are presented using valid XML format. User configurable PCDATA is listed under

supported values and appears as bold, italicized text in example code.

84 Deployment

For example:

suse1

Table 59. openSUSE-specific operating system settings

Field Description Supported values

operatingsystemconfig

configtype Operating system configuration type. The autoyast file contains configurations that are required for operating system installation.

autoyast

autoyast configdata settings

configdata Use the sample autoyast file and update the configurable attributes.

NOTE: The XML elements are grouped and nested within attribute categories as listed in this table.

See the sample autoyast configdata

general mode

confirm config:type="boolean"

Enter a value of false so that the autoyast settings are automatically accepted and the installation can start.

true or false

final_halt config:type="boolean"

Enter the value false so that the VM does not shut down after the operating system is installed and configured.

true or false

timezone

hwclock Set whether the hardware clock uses local time or UTC. The default is UTC.

localtime or UTC

timezone Set the server time zone. Example:

America/Chicago

networking

keep_install_network config:type="boolean"

Merges the network configuration of the VM with the network configuration that is defined in this file. Set this element to true.

true or false

dns Nest the following elements within the DNS element and provide the necessary networking values:

hostname: This optional element provides the hostname, excluding the domain name. For example:

suse1 nameserver: Provide the IP address of the VM. For multiple

VMs, repeat this line for each IP address. For example:

1.2.3.4 1.2.3.3

See description

interfaces config

bootproto Specify whether to obtain the network settings from DHCP or set them manually. The supported values are dhcp or static.

Set bootproto to dhcp when using a hardware profile to deploy the operating system on multiple servers.

The following fields are not required if bootproto is set to dhcp:

dhcp or static

Deployment 85

Table 59. openSUSE-specific operating system settings (continued)

Field Description Supported values

broadcast device ethtool_options ipaddr netmask Use dhcp when a DHCP server is set up (either an external DHCP server or local). This action provides IP addresses to the host operating system on the target server. If DHCP is used, then only the device name and the startmode are supplied.

You can set bootproto to either static or dhcp when using a server YAML file to deploy the operating system. If the server has one or more NICs with multiple network ports to set up, add a separate interface section for each port.

broadcast The broadcast IP address. This element is not required with DHCP.

A valid IP address

device A user-defined name for the interface. This element is not required with DHCP.

Example: p1p1

ethtool_options Optionally, specify the ethtool option during device activation. This element is not required with DHCP.

autoneg on or

autoneg off

ipaddr The IP address that is assigned to the interface. This element is not required with DHCP.

A valid IP address

netmask The subnet mask of the server. This element is not required with DHCP.

A valid subnet mask

startmode Defines when to bring up an interface. Supported values include: onboot hotplug auto ifplugd manual nfsroot off

Example: onboot

routing

destination Defines the route destination. This element is not required with DHCP.

Only one destination can be the default route. When defining multiple routes, you can assign the other destinations an IP address prefix.

default

For additional routes, an IP address prefix.

Example: 100.10.1.0/24

gateway The default gateway IP address. This element is not required with DHCP.

A valid IP address

device Enter the device name of the interface to associate with this route. This element is not required with DHCP.

Example: p1p1

services manager

services This is an optional section that you can add to automatically start system services after openSUSE is installed. Enter as many services as you want started.

See sample file

software

86 Deployment

Table 59. openSUSE-specific operating system settings (continued)

Field Description Supported values

package The first two instances of the package element define the software packages that are required to run the second stage of the operating system installation.

autoyast2-installation

autoyast2

package Optionally, you can install other software packages during the operating system deployment. For example: openssh vim-data zypper iputils vim bash curl

See description

partitioning config

drive This mandatory section is added to install the operating system on a specific drive and to format the data from the drive.

See sample file

users config

user Defines the username, password, and if password encryption is used for a user. If you have multiple users, add a separate user code block for each user.

Set encrypted config to true if an encrypted password is used. Set to false if the password is not encrypted.

Enter the user password in the user_password element. Enter the user name in the username element.

NOTE: Ensure that the user is already set up for root access on the VM.

For encrypted config:

true or false

The following table lists only the configurable Red Hat Enterprise Linux-specific operating system YAML attributes.

Table 60. Red Hat Enterprise Linux-specific operating system settings

Field Description Supported values

operatingsystemconfig

configtype Operating system configuration type. The Kickstart file contains configurations that are required for operating system installation.

kickstart

kickstart configdata settings

configdata Use the sample kickstart file and update the following attributes.

For information about Kickstart file commands, see APPENDIX J. KICKSTART COMMANDS AND OPTIONS REFERENCE in the Red Hat Enterprise Linux 8 System Design Guide on the Red Hat Customer Portal.

NOTE: The blank lines between each command in the configdata section are required for successful operating system deployment.

See sample kickstart configdata

rootpw Enter the host operating system password for root user. This is a user-supplied value.

lang Set the server language. The default is en_US. Example: es_ES

Deployment 87

Table 60. Red Hat Enterprise Linux-specific operating system settings (continued)

Field Description Supported values

See the Red Hat website for a complete list of supported languages.

keyboard Set the keyboard language. The default is us.

See the Red Hat website for a complete list of supported languages.

Example: fr

timezone Set the server time zone. The default is America/New_York --isUtc.

See the Red Hat Enterprise Linux website for information about the time zone and supported values.

Example:

America/New_York --isUtc

network Add server network information where you are installing the operating system.

--bootproto: specify whether to obtain the network settings from DHCP or set them manually. The supported values are dhcp or static.

NOTE: For PXE boot, the bootproto must be set to dhcp.

The following fields are required if bootproto is set to static:

ip IP address of the server

gateway Default gateway IP address

netmask Subnet mask of the server

nameserver IP address of the DNS server. Omit this option if you do not intend to use a DNS server

vlanid The VLAN the server is on.

--device: specify the MAC address of either the network card or the server. For example: A0:12:10:00:C0:D3

--hostname: The server hostname. For example: rhel1.dell.com. This is an optional field.

-- network adapter settings: specify whether to enable or disable the VirtualizationMode. The supported values are SRIOV to enable, or NONE to disable.

Set bootproto to dhcp when using a hardware profile to configure the network attributes. Only one network entry is needed to install the operating system on multiple servers using a hardware profile.

Set bootproto to either static or dhcp when using a server YAML file to configure the network attributes. If the server has one or more NICs with multiple networking ports to set up, add separate network entries for each on separate lines in the server YAML file. Include the device attribute. Specify the MAC address of the NIC that you are setting up, which is from the BMC settings. The first NIC is used by default if the device attribute is omitted.

See sample YAML file

selinux Enable or disable Security-Enhanced Linux (SELinux) for the server.

--disabled

--enforcing

--permissive

88 Deployment

Table 60. Red Hat Enterprise Linux-specific operating system settings (continued)

Field Description Supported values

firewall Enable or disable the Red Hat Enterprise Linux default firewall for the server.

--enabled or --disabled

@'minimal-environment Install the minimum required Red Hat Enterprise Linux operating system packages on the server. Dell Technologies recommends installing the minimal package.

@'minimal-environment

The following table lists configurable Ubuntu 18.04 LTS specific operating system YAML attributes.

Table 61. Ubuntu 18.04 LTS operating system settings

Field Description Supported values

operatingsystemconfig

configtype Operating system configuration type.

For more information about the Ubuntu installation attributes, see Ubuntu Server Documentation.

preseed

ipAddressDetails: Enter the following details of the server: ipAddressIP address of the server gatewayDefault gateway IP address netmaskSubnet mask of the server

See sample YAML file

configdata settings

configdata Use the sample configdata in the example YAML files and update the attributes for the operating system installation.

NOTE: Any blank line shown between commands in the configdata section is required for successful operating system deployment.

See sample configdata

language/location Set the language and location string attributes for the operating system installation. The following example shows the language set to US English and the United States as the country. d-i debian-installer/language string

en_US:en d-i debian-installer/country string US d-i debian-installer/locale string en_US d-i debian-installer/splash boolean false

See example

console/keyboard Set the console and keyboard attributes for the operating system installation. The following is a common example using US English settings. d-i console-setup/ask_detect boolean false d-i console-setup/layoutcode string us d-i keyboard-configuration/modelcode string

pc105 d-i keyboard-configuration/layoutcode

string us d-i keyboard-configuration/variantcode

string intl d-i keyboard-configuration/xkb-keymap

select us(intl) d-i debconf/language string en_US:en

See example

netcfg Set the network configuration (netcfg) attributes for static or DHCP networking.

user defined

Deployment 89

Table 61. Ubuntu 18.04 LTS operating system settings (continued)

Field Description Supported values

For static networking, enter values for the following strings. Keep the default values for the other netcfg strings related to static networking as shown in the sample YAML file.

d-i netcfg/choose_interface select

where is for either the network card or the server. For example: A0:12:10:00:C0:D3

d-i netcfg/get_nameservers string

where is the IP address of the DNS server.

For DHCP networking, ensure that the server is on a network that has a DHCP server enabled. The DHCP server should be configured with an indefinite or a long IP lease expiration value.

Enter a MAC address value in the following netcfg string. Keep the default values for the other netcfg strings related to DHCP networking as shown in the sample YAML file.

d-i netcfg/choose_interface select

Set the following for static and DHCP networking:

d-i netcfg/get_hostname string {{.OSNetworkingDetails.HostName}}

d-i netcfg/get_domain string unassigned-domain d-i netcfg/hostname string

{{.OSNetworkingDetails.HostName}}

password/user Update the following strings to SSH into the server after the operating system is installed.

In the passwd/user-fullname string, enter a human- readable name that is displayed.

In the passwd/username string, enter the login username.

The user-fullname and username attributes can have the same value.

You must also provide a hashed password that is encrypted. In the passwd/user-password-crypted string, enter the hashed password.

For example, you can hash the SSH login password using mkpasswd:

mkpasswd -m sha-512 NOTE: SSH as root user is disabled. The created user has sudo permissions.

user defined

time/zone/clock Enter a value in the time/zone string. For example:

d-i time/zone string America/Los_Angeles Keep the default value of false for the clock-setup/utc and clock-setup/ntp strings.

Example:

Los_Angeles

The following table lists configurable Ubuntu 20.04 LTS specific operating system YAML attributes.

90 Deployment

Table 62. Ubuntu 20.04 LTS operating system settings

Field Description Supported values

operatingsystemconfig

configtype Operating system configuration type.

For more information about the Ubuntu installation attributes, see Ubuntu Server Documentation.

cloud-init

ipAddressDetails: Enter the following details of the server: ipAddressIP address of the server gatewayDefault gateway IP address netmaskSubnet mask of the server nicNameThe name of the NIC. For example: id0

See sample YAML file

configdata settings

configdata Use the sample configdata in the example YAML files and update the autoinstall attributes for the operating system installation.

NOTE: Any blank line shown between commands in the configdata section is required for successful operating system deployment.

See sample configdata

drivers

install Install drivers during the operating system installation. true or false

identity

password Enter the Base64 encoded password for the new user. This is required for use with sudo, even if SSH access is configured.

user-defined

realname Optionally, enter the real name for the user.

username Enter the username that you want to create. The username can be the same as the realname.

apt

preserve_sources_list Define if the install package source list is merged or replaced. A value of true merges the source list. A value of false replaces the source list.

true or false

primary If you are installing packages from a special repository, you can optionally enter the repository address that is used to configure apt-get. The default Ubuntu repo is used.

Example:

primary: - arches: [i386, amd64] uri: "http://archive.ubuntu.com/ubuntu" - arches: [default] uri: "http://ports.ubuntu.com/ubuntu- ports"

You can enter the specific architecture for the package. Supported options are i386 or amd64. Packages of both architectures are searched for when this attribute is left blank.

Use the default public repository URI of http:// archive.ubuntu.com/ubuntu or enter a different URI.

See example

Deployment 91

Table 62. Ubuntu 20.04 LTS operating system settings (continued)

Field Description Supported values

Use the default URI for the ports http:// ports.ubuntu.com/ubuntu-ports or enter a different URI.

geoip Define to enable or disable a geoip look up. The default value is true. If set to false, the request times out after 10 seconds.

When set to true, a request is made to https://geoip.ubuntu.com/lookup. The default mirror URI changes to https:// .archive.ubuntu.com/ ubuntu where is the country code that is returned by the lookup.

true or false

packages, keyboard, and locale

packages Optionally, you can install software packages during the operating system installation. Networking must already be working on the host server to access the repositories where those packages reside.

A valid package name

For example:

dkms

keyboard Define the keyboard attributes. For example: layout: us toggle: null variant: ' ' (i.e. no value is set)

See example

locale Set the locale of the server that is hosting the operating system. Example:

en_US.UTF8

ssh

allow-pw Allows the use of a password when accessing the host server using SSH. Set to true if the authorized_keys attribute is empty.

true or false

authorized-keys Optionally, enter a list of the SSH public keys to install in the initial user account that is used to deploy the operating system.

user-defined

install-server Specify if you want to install OpenSSH server on the target system. The default is false.

true or false

storage

layout Specify the name of the layout. Supported values are lvm and direct. The default is lvm.

Do not set the match attribute. The device serial number is automatically inserted during the installation.

direct or lvm

network (version 2)

ethernets Define the physical network interfaces on the target server.

The following shows example YAML that defines two NICs (id0 and id1) with DHCP set to true.

network: version: 2 ethernets: #Arbitrary ID only used for reference. #id1, id0 will be used to create bonds id0: match: macaddress:

See example

92 Deployment

Table 62. Ubuntu 20.04 LTS operating system settings (continued)

Field Description Supported values

dhcp4: true id1: match: macaddress: dhcp4: true

In this example, the following attributes for each interface are configured:

macaddress: specify the MAC address of either the network card or the server. For example: A0:12:10:00:C0:D3

dhcp: enable DHCP for the NIC. Values are true or false.

For static IP addressing, you can use the following attributes:

macaddress: specify the MAC address of either the network card or the server.

set-name: Optionally, assign a new name to the NIC. addresses: Enter the static IP addresses to assign to the

server. gateway4: Enter the IP address of the gateway. nameservers:

addresses: Enter the IP address of the DNS nameserver.

network: version: 2 ethernets: #Arbitrary ID only used for reference. #If using multiple NICs, use unique ids id0: match: macaddress: #Set new name for the NIC(optiona) set-name: addresses: - gateway4: nameservers: addresses: -

bonding Optionally, you can specify any standard Netplan formatted network configuration for the network interfaces. For information, see Netplan examples.

For example, you can specify multiple NICs, enable DHCP, and more. The following shows an example of a network bonding configuration for two NICs (id0 and id1). DHCP is set to true for the two NICs.

bonds: bond0: # name of the bond #set all the physical interfaces for #the bond0 interfaces: #use ids specified in ethernets #stanza - id0 - id1 #If you don't want a static IP, remove #the `addresses` stanza and uncomment #the dhcp4 line below. #dhcp4: false

See example

Deployment 93

Table 62. Ubuntu 20.04 LTS operating system settings (continued)

Field Description Supported values

#Define the bond static IP and #gateway addresses: - routes: - to: default via: #Typical DNS servers nameservers: addresses: - #Set the Bond parameters parameters: #it could be balance-rr, active- backup, #balance-xor, broadcast among others mode:

You can specify the following for each interface:

macaddress: specify the MAC address of either the network card or the server.

dhcp: enable DHCP for the NIC. Values are true or false.

NOTE: For static IP addressing, you can omit this bonding attribute section and set static IP addressing using ethernets attributes.

Also set the bonding parameters mode. For example: balance-rr, active-backup, balance-xor, and broadcast among others.

The following table lists configurable Wind River Cloud Platform-specific operating system YAML attributes.

Table 63. Wind River Cloud Platform operating system settings

Field Description Supported values

operatingsystemname The name of the operating system media.

This name must match the metadata name value in the media object.

Example: wrmedia

operatingsystemconfig

bootMenuOption Sets the Wind River stack deployment mode. Supported options include:

Option 2: All-in-one duplex mode for serial consoles Option 3: All-in-one duplex mode for graphical consoles

2 or 3

installVolumeID The FQDD identifier of the RAID, HBA, SD card inventory, or NVMe volume to install the operating system on.

Updating the installVolumeID in a hardware profile requires that the volume must have the same identifier available on all servers that the profile targets.

Optional field. If no value is specified, the system selects a volume for installing an operating system from the installVolumeTypeOrder field.

Examples:

For RAID: Disk.Virtual.0:RAID.Slot.2-1

For SD card inventory: Disk.SDInternal.1

installVolumeTypeOrder Specify the order in which the type of volume is selected for installing an operating system.

The system checks the volumes starting with the first volume type. If the volume type is present on the server, the operating

NVME

SDCARD

RAID

HBA

94 Deployment

Table 63. Wind River Cloud Platform operating system settings (continued)

Field Description Supported values

system is installed on that volume. If that volume type does not exist on the server, the next type is checked.

Optional field. If no value is specified, the system selects the volume for installing an operating system from the installVolumeID field.

For HBA, SDCARD, NVME and BOSS, the first volume name of that type that displays in the storage field of the status section is selected for operating system installation.

For RAID, you can specify the volume name. It must match the value set for the attribute name in the raidVolumes.

Delete all RAID volumes available on the server where the operating system was previously deployed if: an operating system is deployed on a specific RAID

volume. you want to install the operating system on a different

RAID volume.

For example, suppose that the Wind River Cloud Platform operating system is deployed on RAID Volume1. To install the operating system on RAID volume2, delete all RAID volumes that are used for the Wind River Cloud Platform operating system installation. You can then perform operating system deployment on RAID Volume2.

BOSS

minimumDiskSize The minimum volume size of the operating system installation that is entered as a numerical value in gigabits. The default value is 500 GB.

Example: 500

configtype Operating system configuration type. The Kickstart file contains configurations that are required for operating system installation.

kickstart

kickstart configdata settings

configdata Use the sample kickstart file and update the following attributes.

NOTE: The blank lines between each command in the configdata section are required for successful operating system deployment.

See sample kickstart configdata

OAM_DEV= Enter the enumerated interface name of the BMC on the server where the operating system is to be installed.

Example:

OAM_DEV=enp94s0f0

OAM_VLAN= Sets the VLAN that the server is on. Example:

OAM_VLAN= 33

DEVICE= Specify the BMC device to use. Example:

DEVICE=OAM_DEV

BOOTPROTO= A boot-time protocol should not be used with the Wind River Cloud Platform. Enter a value of none.

none

IPADDR= The IP address of the server that is hosting the operating system.

A valid IP address

PREFIX= Enter the network subnet value. Example: 24

GATEWAY= Default gateway IP address. A valid IP address

Deployment 95

Table 63. Wind River Cloud Platform operating system settings (continued)

Field Description Supported values

ONBOOT= Specify if you want the interface to be activated at boot time. yes or no

VLAN Specify if the server is on a VLAN. yes or no

LINKDELAY= The amount of time that is entered (as an integer in seconds) to wait for link negotiation to complete before configuring the device.

Example: LINKDELAY= 30

OS Drivers

You can apply custom OS drivers to a hardware profile.

See Install OS custom drivers for details on installing OS drivers.

Firmware settings

You can specify firmware to include in a hardware profile.

Prerequisites

Firmware media must be already uploaded to Bare Metal Orchestrator (see Create firmware media).

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit.

3. From the Actions drop-down list, select Edit. The Edit Hardware Profile window displays.

4. In the Firmware dialog box, click Add Firmware.

5. Review the list of available firmware.

6. Click the check box next to the firmware that you want to include in the hardware profile.

7. Click Save.

Network adapter settings

You can specify the network adapter settings in a hardware profile.

Prerequisites

Enable SR-IOV in the BIOS settings in advance before you enable SR-IOV on the network adapter (see BIOS settings).

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit. Alternatively, select Create to create a hardware profile (see Create a hardware profile).

3. From the Network Adapter Settings field, select Configure.

4. From the Network Adapter Settings window, click the plus icon.

5. In the FQDD field, enter the fully qualified device descriptor of the network adapter. For example: NIC.PxeDevice.1.

6. From the SR-IOV Status switch, toggle the switch to enable SR-IOV for the network adapter, and then click Save.

96 Deployment

Edit network adapter settings

Once you have completed and saved a hardware profile, you can edit the network adapter settings.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

3. From the Network Adapter Settings field, select Edit.

4. Click Edit next to the network adapter that you want to edit.

5. Complete the following fields as required, then click Save:

Table 64. Network adapter settings

Field Description Supported values

NIC Name The name of the network adapter Any meaningful name.

Virtualization Mode Enables or disables the port that is configured for SR-IOV.

SRIOV or NONE

Banner Message Timeout NIC interface banner message timeout 0 to 14 inclusive

Setup Key NIC interface setup keystroke Broadcom_SetupKeyCtrlS, Broadcom_SetupKeyCtrlB

Hide Setup Prompt NIC interface hides setup prompt Enabled or Disabled

Error Recovery NIC interface adapter error recovery Enabled or Disabled

Max PfMsix Vectors NIC interface maximum number of PF MSI-X Vectors

0 to 512 inclusive

Add a network adapter

Add a network adapter to an existing hardware profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

3. From the Network Adapter Settings window, select Add a NIC.

4. Complete the following fields as required, then click Save:

Table 65. NIC settings

Field Description Supported values

NIC Name The name of the network adapter Any meaningful name.

Virtualization Mode Enables or disables the port that is configured for SR-IOV.

SRIOV or NONE

Banner Message Timeout NIC interface banner message timeout 0 to 14 inclusive

Setup Key NIC interface setup keystroke Broadcom_SetupKeyCtrlS, Broadcom_SetupKeyCtrlB

Hide Setup Prompt NIC interface hide setup prompt Enabled or Disabled

Error Recovery NIC interface adapter error recovery Enabled or Disabled

Max PfMsix Vectors NIC interface maximum number of PF MSI-X Vectors

0 to 512 inclusive

Deployment 97

Deleting a network adapter

Delete a network adapter from an existing hardware profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

3. From the Network Adapter Settings field, select Edit for the NIC that you want to delete.

4. From the Edit a Network Adapter window, select Delete NIC, then select Yes in the pop-up window to confirm.

Editing a port

Edit a port in an existing hardware profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

3. From the Network Adapter Settings window, select Edit for the network adapter that contains the port.

4. From the Port Details section, select Edit for the port that you want to edit.

5. Edit the following fields, then click Save:

Table 66. Port settings

Field Description Supported values

Port ID The ID of the port Port ID

Forward Error Correction NIC interface link FEC Enabled or Disabled

Port Link Training NIC interface port link training Enabled or Disabled

Legacy Boot Proto NIC interface legacy boot protocol PXE, NONE

rDMANIC Mode On Port NIC interface and RDMA mode Enabled or Disabled

MSIX Vectors PerVF NIC interface number of MSIX vectors per VF

0 to 128 inclusive

Operational Link Speed NIC interface operational link speed AutoNeg, 10Gbps, 25Gbps

dCBX NIC interface DCBX mode Disabled, Enabled_IEEE,

Enabled_CEE,

Enabled_Both_IEEE_CEE

aNProtocol NIC interface autonegotiation Protocol Broadcom_ANProtocolIEEEandBAM,

Broadcom_ANProtocolIEEEandConsorti um,

Broadcom_ANProtocolIEEE8023by,

Broadcom_ANProtocolBAMOnly,

Broadcom_ANProtocolConsortiumOnly

Media Auto Detect NIC interface media autodetect Enabled or Disabled

Default EVB Mode NIC interface default eVB mode VEB, VEPA, None

Boot Option ROM NIC interface option ROM Enabled or Disabled

Boot Strap Type NIC interface boot strap type AutoDetect, BBS, Int18h, Int19h

Wake on LAN NIC interface wake on LAN Enabled or Disabled

98 Deployment

Table 66. Port settings (continued)

Field Description Supported values

vLAN Mode NIC interface virtual LAN mode Enabled or Disabled

Boot Retry Count NIC interface boot retry count NoRetry, 1Retry, 2Retries,

3Retries, 4Retries, 5Retries,

6Retries, IndefiniteRetries

Permit Total Port Shutdown NIC interface permit total port shutdown

Enabled or Disabled

Port Settings Scope Choose to apply the NIC settings to one port or all the ports.

Apply settings to this port or Apply settings to all ports in this NIC

Deleting a port

Delete a port from an existing hardware profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

3. From the Network Adapter Settings window, select Edit for the NIC that contains the port that you want to delete.

4. From the Edit Port window, select Delete NIC, then select Yes in the pop-up window to confirm.

Telemetry enablement

Telemetry is an automated communications process by which measurements and other data are collected at remote or inaccessible points. You can collect metrics for individual servers by applying a hardware profile where telemetry is enabled.

Create a telemetry hardware profile

Follow these steps to enable telemetry and set telemetry report parameters on a profile:

Steps

1. From the left-side menu, click Deployment > Hardware Profile. The Deployment: Hardware Profile window is displayed.

2. From the Actions menu, select Create. The Create Hardware Profile window is displayed.

3. Enter a profile name in the Name field.

4. Configure other settings as required.

5. Under Telemetry Enablement, select Turn On from its menu.

6. Click Configure to open the Telemetry parameters window.

Results

See https://dl.dell.com/manuals/all-products/esuprt_solutions_int/esuprt_solutions_int_solutions_resources/enterprise- solution-resources_white-papers33_en-us.pdf for definitions of all telemetry parameters.

Set telemetry parameters

Set the report parameters after you enable telemetry.

Steps

1. Optional: Set the Remote syslog (RSyslog) IP addresses and ports: Rsys Log Server 1, Rsys Log Server 1 Port, Rsys Log Server 2, Rsys Log Server 2 Port.

Deployment 99

2. Click Next to advance to the next telemetry parameter or click the parameter name in the left panel. All telemetry parameters have the same report options. The report parameters for the specified metric are displayed.

3. Configure these report settings as required:

Table 67. Telemetry report settings

Report Setting Options

Metric Report State Options are:

Enabled: Enables reporting on this metric. Disabled: Disables reporting on this metric.

You can set this differently for individual metrics.

Metric Report Type Specifies when a report should be sent. Options are:

On Change: Generates a report when a metric has changed. The minimum time between reports is 10 seconds to prevent overloading several subsystems. If multiple metrics are changed during this 10 second period, the report includes all metrics that have changed up until the report generation time. The following settings are required: Report Time Span: Set to a non-null value. Suppress Repeated Metric Value: Set to true.

On Request: Generates a report on demand. Requirements include: The Report Updates field is ignored in the input. The output is set to

Append Wraps When Full. The Report Actions field is ignored in the input. The output is set to

Log to Metrics Reports Collection. The Report Time Span must have a value greater than 0. The schedule must either not be present in the input, or the

Recurrence Interval field must be set to null. Periodic: The default value for any new reports that are uploaded with an

unspecified report type. The report is repeatedly generated on a periodic basis as specified by the Recurrence Interval value.

Report Actions Specifies what occurs when a report is generated per the Metric Report Type value. This property is an array. Options include:

Log to Metric Reports Collection: The report is saved to the metric reports collection with an ID that matches the report definition.

Redfish Event: Report is sent as a Metric Report event type to all users. Logging to both options is permitted.

Report Updates How a report is handled after the first report is generated. Specifies what to do with subsequent metric reports when the MetricValues array is full: Append Stops When Full: Each time a report is generated, new metric

values are added to the end of the array. The report can contain up to an Append Limit number of metric values. Once this number is reached, no more can be appended to the report. Reports do not stream once they have stopped. When the append limit is reached, streaming may not immediately stop, but should stop within 15 minutes of reaching the limit.

Append Wraps When Full: When the report is created, new metrics are added to the array, and existing entries are retained. Once the metrics in the array exceed the append limit, older entries above the Append Limit setting are deleted from the report.

New Report: Adds a report and generates a name that takes the report definition name and adds a dash and the current date and time to it.

Overwrite: Overwrites an older report with a new report of the same name. This is the default setting for this attribute.

Suppress Repeated Metric Value Options are: Enabled: Suppresses the generation of identical, repeated metric reports. Disabled: Default setting for new custom reports.

100 Deployment

Table 67. Telemetry report settings (continued)

Report Setting Options

Metric Report Heartbeat Interval Periodically forces a report that contains at least one value for every valid metric. This property must always be greater than or equal to the Recurrence Interval. It is only valid for Periodic type reports. The default is 0 (disabled).

For metric reports with the Suppress Repeated Metric Value enabled, some metrics do not change for a long time and do not show up in many reports. This is expected behavior, but some users want to have periodic reminders of the metrics that are valid for a report. This heartbeat setting is important as it forces a report with one value for every valid metric.

Recurrence Interval When the Metric Report type is set to Periodic, the recurrence interval specifies how frequently the report is sent in hours, minutes, and seconds. A value of 0 generates a single non-repeating report. This property is only used with Periodic type reports.

Report Time Span Optionally specifies the duration of the report. This attribute must be set if the report is only required for a specific period or time span.

NOTE: For more information, see https://dl.dell.com/manuals/all-products/esuprt_solutions_int/

esuprt_solutions_int_solutions_resources/enterprise-solution-resources_white-papers33_en-us.pdf.

4. Click Finish once all report parameters are set. The system returns to the main Hardware Profile window.

5. Click Save to apply changes to the telemetry hardware profile.

Telemetry attributes

This table contains telemetry field definitions.

Table 68. Telemetry field definitions

Field Description

Rsys Log: Remote syslog implements the basic syslog protocol, and extends it with content-based filtering, rich filtering capabilities, and flexible configuration options.

Rsys Log Server 1 Remote syslog server 1 address IPv4, IPV6, or FQDN.

Rsys Log Server 1 Port Remote syslog server 1 port.

Rsys Log Server 2 Remote syslog server 2 address IPv4, IPV6, or FQDN.

Rsys Log Server 2 Port Remote syslog server 2 port.

Telemetry reports:

Aggregation Metrics Contains base metric values for power, temperature, and CPUS (CPU, Memory, IO, System).

CPU Metrics Contains CPU Memory metrics.

CPU Registers On the Intel platform, the report represents the MSR registers. On the AMD platform, the report represents the MCA registers. The CPU Register dump is platform-specific.

CPU Sensor Contains CPU sensor data.

FC Port Statistics Contains Fibre Channel Port statistics.

FC Sensor Contains the FC temperature reading.

FPGA Sensor Contains the Field Programmable Gate Arrays (FPGA) temperature reading.

Fan Sensor Contains fan speed readings in RPM.

Deployment 101

Table 68. Telemetry field definitions (continued)

Field Description

GPU Metrics Contains Graphics Processing Unit Health metrics.

GPU Statistics Contains Graphics Processing Unit Frame Buffer and Graphic Device (GD) memory ECC (Error-correcting code) statistics data.

Memory Sensor Contains the memory temperature reading.

NIC Sensor Contains the Network Card temperature reading.

NIC Statistics Contains NIC Port and Partition Statistics.

NVMe Smart Data Contains the NVMe SMART Health record.

PSU Metrics Contains power supply metrics.

Power Metrics Contains power consumption data for all CPUs, DIMMs, System Input, and System Output.

Power Statistics Contains system power consumption statistics.

Sensor Contains all IPMI readings.

Serial Log Contains the Serial Log Report (server serial logs).

Storage Disk Smart Data Contains SSD SMART information.

Storage Sensor Contains temperature information for the storage internal drives.

System Usage Contains system usage that is expressed as a percentage. This report is platform-dependent, and data may not be available on all platforms.

Thermal Metrics Contains thermal metrics.

Thermal Sensor Contains a temperature reading.

Edit a telemetry hardware profile

Follow these steps to edit a telemetry hardware profile:

Steps

1. From the left-side menu, click Deployment > Hardware Profile. The Deployment: Hardware Profile window is displayed.

2. Select the hardware profile that you want to edit.

3. From the Actions menu, select Edit. The Edit Hardware Profile window is displayed.

4. Under Telemetry Enablement, click Edit. The Telemetry Enablement parameters window opens.

5. Make the required changes and click Finish. The system returns to the main Hardware Profile window.

6. Click Save to apply changes to the telemetry hardware profile.

Delete a telemetry hardware profile

Follow these steps to delete a hardware telemetry profile:

Steps

1. From the left-side menu, click Deployment > Hardware Profile. The Deployment: Hardware Profile window is displayed.

102 Deployment

2. Select the hardware profile that you want to delete.

3. From the Actions menu, select Delete. The system displays a message asking you to confirm that you want to delete this profile.

4. Click Yes to complete the deletion process.

Apply a telemetry profile to a server

Follow these steps to apply a telemetry profile to one or more servers:

Steps

1. From the left-side menu, click Inventory. The Inventory window is displayed (if it was previously selected).

2. Select one or more servers.

3. From the Actions menu, select Apply Hardware Profile. The Select Hardware Profile window is displayed.

4. Select a profile from the Hardware Profile menu.

5. Click Apply to apply the profile to the selected servers.

Remove a telemetry profile from a server

Follows these steps to remove a telemetry profile from one or more servers:

Steps

1. From the left-side menu, click Inventory. The Inventory window is displayed (if it was previously selected).

2. Select one or more servers.

3. From the Actions menu, select Remove Hardware Profile. The Select Hardware Profile window is displayed.

4. Select the profile that you want to remove from the Hardware Profile menu.

5. Click Apply to remove the profile from the selected servers. The system removes the profile.

View server telemetry configuration

View the server telemetry configuration from the Inventory page for the server.

Prerequisites

You must first onboard the server to Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Inventory.

The Inventory page displays with Compute selected by default.

2. Hover over the IP address of the selected server to open the dialog box and click View Device.

3. Click Telemetry to view the telemetry configuration.

Set power options

You can turn power on and off in a new hardware profile, or by editing this setting in an existing hardware profile. When you apply the hardware profile to multiple servers simultaneously, you can power on or power off all servers in a data center at once.

Steps

1. From the left-side menu, select Deployment > Hardware Profile. The Deployment: Hardware Profile page displays.

Deployment 103

2. Select the check box next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit.

Alternatively, select Create to create a hardware profile (see Create a hardware profile).

Power Options are located below Operating System settings.

Figure 21. Power options

3. You have two options: Set power state: Click this radio button and select Power On or Power Off from the drop-down list. Do not change power state: Click this radio button to maintain the current power state. It also disables the drop-down.

4. Click Save to apply your changes to the hardware profile.

Configure OS network settings

Specify the Operating System network settings in a hardware profile. The OS network settings only apply for ESXi system installation.

Prerequisites

You must configure the Operating System settings in the hardware profile before you configure the OS network settings.

Steps

1. From the left-side menu, select Deployment > Hardware Profile. The Deployment: Hardware Profile page displays.

2. Select the checkbox next to the hardware profile that you want to edit, and from the Actions drop-down list, select Edit. Alternatively, select Create to create a hardware profile (see Create a hardware profile).

3. From the OS Network Settings dialogue box, select Configure. The OS Network Settings window displays.

4. Click + next to each field to add the following information:

Table 69. OS network settings

Field Description

NTP Server IP address of the NTP server.

DNS Server IP address of the DNS server.

DNS Search Relevant DNS search parameters.

5. Click Save.

Edit a hardware profile

Prerequisites

Be sure the hardware profile that you want to edit is not in use by a server.

104 Deployment

CAUTION: Do not edit a hardware profile that is in use by a server. If this occurs, Bare Metal Orchestrator

displays a warning to prevent unintentionally affecting many servers.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to edit.

3. From the Actions drop-down list, select Edit.

4. To edit configuration settings: Under BIOS Settings, click Configure and update the required fields.

For more information, see BIOS settings.

Under BMC Settings, click Configure and update the required fields.

For more information, see BMC settings.

Under RAID Settings, click Configure and update the required fields.

For more information, see RAID settings.

Under Operating System, click Add OS and update the required fields.

For more information, see Deploy an operating system.

Under Firmware, click Add Firmware and update the required fields.

For more information, see Firmware settings.

Under Network Adapter Settings, click Configure and update the required fields.

For more information, see Network adapter settings.

Under OS Network Settings, click Configure and update the required fields.

For more information, see Configure OS network settings

5. Select Reinitialize Drives if you want the hardware profile to perform a secure erase on all drives.

CAUTION: This is a destructive operation that can result in data loss.

NOTE: SD cards (if present) and BOSS card volumes are not erased when you select Reinitialize Drives.

6. Click Save.

Duplicate hardware profile

You can copy the hardware profile settings to a new profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Select the check box next to the hardware profile that you want to duplicate.

3. From the Actions drop-down list, select Duplicate.

4. In the Duplicate Name box, enter a name for the new hardware profile.

5. Click Duplicate. The duplicate hardware profile is displayed on the Deployment: Hardware Profile page.

Delete hardware profiles

You can delete any hardware profiles except for the baseline profile.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

Deployment 105

2. Select the check box next to the hardware profile that you want to delete.

3. From the Actions drop-down list, select Delete. A confirmation dialog is displayed.

4. Click Yes to confirm deletion.

Firmware for deployment Upload and manage firmware media that you can deploy to servers onboarded to Bare Metal Orchestrator.

On the left-side menu, select Deployment > Repository to view the Deployment: Repository page (media repository). The Firmware tab displays the list of firmware images that were previously uploaded.

Use firmware that is uploaded to Bare Metal Orchestrator to update server BIOS, disk controllers, or other hardware. See Create firmware media.

CAUTION: Uploading large firmware files can cause the upload to fail. If this occurs, use the CLI to upload files.

Create firmware media

Create and upload firmware installation media for servers.

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the Firmware tab.

3. From the Actions drop-down list, select Create. The Create Firmware window opens.

4. Enter these fields as required.

Table 70. Firmware installation media

Field Description

Name Descriptive name for the firmware.

Type The firmware type. Select either Switch or Server from the drop-down list.

Vendor The vendor name.

Category The firmware category. For example, BIOS, Diagnostics, Memory, Network.

Model The model name of the server.

Firmware Name The name to identify the firmware.

Version The firmware version.

External IP If the site worker node has an IP address that is not directly accessible from the BMC, enter the external IP address of the Bare Metal Orchestrator VM here.

Firmware File Click Choose File to upload the firmware image. For example, firmware/ Diagnostics_Application_0G1JH_WN64_6.0_A00_01.EXE

NOTE: Firmware images are stored on the web server.

5. Click Save to create the firmware media and return to the Deployment: Repository page.

A status message confirms creation of the firmware media.

6. Optional: To verify that the firmware media uploaded, check the Firmware tab to see if it is listed in the repository.

Results

After adding the firmware media, you can edit or delete it. See Edit or delete firmware media.

106 Deployment

Edit or delete firmware media

You can edit or delete existing firmware media.

Prerequisites

Firmware media must exist on Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the Firmware tab.

3. Select the firmware media that you want to edit or delete.

4. From the Actions drop-down list, select Edit or Delete.

You can edit the Vendor, Category, Model, Firmware Name, Version, and External IP fields.

5. Click Save to complete this process.

Operating systems for deployment Use Bare Metal Orchestrator to upload and manage operating system media. 1. From the left-side menu, select Deployment > Repository to view the Deployment: Repository page (media repository). 2. Click the OS tab to display a list of previously uploaded operating system images.

NOTE: You can upload operating system and hypervisor ISO files that you can install on onboarded servers. See Create

operating system media.

CAUTION: Uploading ISO images larger than 10 GB on slow connections may cause the upload to fail. If this

occurs, use the CLI to upload the image.

Create operating system media

Create and upload operating system installation media for servers.

About this task

Bare Metal Orchestrator supports these operating systems and versions:

Table 71. Validated operating systems and hypervisors for servers

Hypervisor or operating system Versions

openSUSE Leap 15.3 (openSUSE-Leap-15.3-3-DVD-x86_64-Build38.1- Media.iso)

Red Hat Enterprise Linux 8.4 (rhel-8.4-x86_64-dvd.iso)

8.5 (rhel-8.5-x86_64-dvd.iso)

Ubuntu 18.04 LTS (ubuntu-18.04.6-server-amd64.iso)

20.04 LTS (ubuntu-20.04.6-live-server-amd64.iso)

VMware ESXi (hypervisor) 7.0 u1, 7.0 u2, and 7.0 u3

Wind River Cloud Platform host operating system

21.05-b58 (wind-river-cloud-platform-host-installer-21.05- b58.iso)

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the OS tab.

Deployment 107

3. From the Actions drop-down list, select Create. The Create Media window opens.

4. Complete these fields as required.

Table 72. OS media

Field Description

Name Descriptive name for the OS.

Type The type of OS media. Select either Switch or Server from the drop-down list.

Vendor The vendor name.

OS Name The OS category. For example, ESXi.

OS Version The OS version.

External IP If the worker node for the site has an IP address that is not directly accessible from the BMC, enter the external IP address of the Bare Metal Orchestrator VM here.

Media File Click Choose File to upload the OS media.

NOTE: OS images are stored on the web server.

5. Click Save to create the operating system media and return to the Deployment: Repository page.

A status message confirms creation of the operating system media.

6. Optional: To verify that the operating system media uploaded, check the OS tab to see if it is now listed in the repository.

Results

After you create the OS media, you can edit or delete it. Editing or deleting operating system media

Editing or deleting operating system media

You can edit or delete existing operating system media.

Prerequisites

Add operating system media to Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the OS tab.

3. Select the operating system media in the Deployment: Repository OS tab.

4. From the Actions drop-down list, select Edit or Delete.

You can edit the Type, Vendor, OS Name, OS Version, or External IP fields.

Deploy an operating system

You can use a hardware profile to deploy an operating system on one or more servers in the Bare Metal Orchestrator cluster.

Prerequisites

Upload the operating system media to Bare Metal Orchestrator and set the media attributes, see Create operating system media.

Steps

1. From the left-side menu, select Deployment > Hardware Profile.

2. Do one of the following:

108 Deployment

Select the check box next to the hardware profile that you want to edit, and then from the Actions drop-down list, select Edit.

From the Actions drop-down list, select Create to create a hardware profile. The Edit Hardware Profile window displays.

NOTE: If this is a new hardware profile, enter a hardware profile name and configure the other attributes (such as the

BIOS) before deploying the operating system.

3. From the Operating System field, click Add OS.

4. From the OS Name drop-down list, select the operating system media.

The system displays these OS-specific details:

Figure 22. Example operating system settings

5. To edit the operating system attributes, click View configuration meta data.

A window opens that is populated with configuration metadata for the selected operating system. Configuration metadata includes DHCP settings, and other user-configurable attributes that you can add or edit with the web UI.

Deployment 109

Figure 23. Example metadata for an ESXi os deployment

6. In the configuration metadata window, enter the root password for the server where the operating system is being deployed.

7. Continue to edit other attributes such as IP addresses, DHCP or static networking, and such. When you are done editing, click Ok.

For tables that list the configurable attribute settings for each operating system, see Operating system settings.

NOTE: If static IP address assignment is used, you can only use the hardware profile to target one server.

CAUTION: Do not check Overwrite Installation when performing an ESXi operating system upgrade. If you

check this option, it removes the current operating system installation and installs a new operating system.

This can result in data loss.

CAUTION: If the target server is deployed in a non-DHCP environment, do not enable DHCP when installing

the operating system. The operating system installation will fail.

8. Optional: Check to upgrade from one version of ESXi to another version. Only use this checkbox for ESXi upgrades. The default setting is cleared.

110 Deployment

CAUTION: The new version of ESXi is installed and wipes out any current installation if the required OS is not

the same as the installed operating system. This also occurs if Bare Metal Orchestrator did not previously

install an operating system on this server.

9. Select the target installation location by specifying either the drive priority or the Fully Qualified Device Descriptor (FQDD).

a. Drive Priority is selected by default. Specify the drive priority by adjusting the order of drive types. Click the corresponding up and down arrows to arrange the drives in order of priority.

SDCARDSecure Digital Memory Card NVMeNon-Volatile Memory Express RAIDRedundant Array of Independent Disks

NOTE: Specify the RAID volume name in the RAID field.

HBAHost Bus Adapter BOSSBoot Optimized Server Storage SRAID

b. Specify a drive by name by selecting the Drive Name [FQDD] radio button and entering the FQDD for the drive.

10. Click Save.

Licenses for deployment Use Bare Metal Orchestrator to upload and manage license media. 1. From the left-side menu, select Deployment > Repository to view the Deployment: Repository page (media repository). 2. Click the License Media tab to display a list of previously uploaded license files.

NOTE: You can upload license media files that you can install on onboarded servers or switches. See Create license media.

Create license media

Follow these steps to create license media on Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the License Media tab.

3. From the Actions drop-down list, select Create. The Create License Media window opens.

4. Enter a license name in the Name field.

5. Click Choose File to upload a license media file to the web server.

6. Click Save to create the license media and return to the Deployment: Repository page.

A status message confirms creation of the license media.

7. Optional: Click the License Media tab and verify that the license media was uploaded.

Results

After you create the license media, you can delete it. See Delete license media.

Delete license media

You can delete existing license media.

Prerequisites

Add license media to Bare Metal Orchestrator.

Deployment 111

Steps

1. From the left-side menu, select Deployment > Repository.

2. Select the License Media tab.

3. Select the license media in the Deployment: Repository License tab.

4. From the Actions drop-down list, select Delete. The system displays a message asking if you want to delete the selected media.

5. Click Yes. The media is deleted from the web server. The License Media page displays, and the media object you deleted is not listed.

OS drivers for deployment Use Bare Metal Orchestrator to upload and manage drivers.

To browse to the OS Drivers page:

1. From the left-side menu, select Deployment > Repository to view the Deployment: Repository page. 2. Click the OS Drivers tab to display a list of previously uploaded driver files.

NOTE: You can upload driver files that you can install on onboarded devices. See Install OS custom drivers.

Install OS custom drivers

Follow these steps to install custom OS drivers.

Prerequisites

A new operating system must be installed before you can add OS drivers. You cannot add a driver to an existing installation. You can perform custom driver installations only when installing or upgrading an operating system on a Dell or Supermicro

server. You must be aware of ESXi compatibility metrics between different release versions, and each version has a device driver

version compatibility. For example, you can access the VMware Compatibility Guide in the following web link: VMWare compatibility guide.

You must create a media object for each type of device driver. For example, if you want to install icen and ibbd drivers, create two different media objects.

Update the type and the version correctly in the driver media file, and the values must match with the operating system driver and version specification.

Steps

1. From the left-side menu, select Deployment > Repository to view the Deployment: Repository page.

2. Click the OS Drivers tab.

3. From the Actions menu, select Create. The Add OS Driver window is displayed.

4. Complete this information:

Table 73. Add OS driver fields

Attribute Name Description

Name Name of the driver

Path Path to the driver.

For servers, the path to the device driver .zip file in the web server. The file name must be included.

Supported values:

Example: http:// :81/data/driver/ Intelicen_1.7.3.0-1OEM.670.0.0.8169922-18990249.zip.

112 Deployment

Table 73. Add OS driver fields (continued)

Attribute Name Description

where is the private IP from which the PXE InBand VLAN is configured. The device drivers are available on HTTP: Port 81 for the Bare Metal Orchestrator web server.

Type Driver type. There are numerous supported driver types, such as icen and ibbd. Refer to the vendor specification for your driver to determine the correct driver type.

Version Driver version. Refer to the vendor specification to determine the correct version for your driver.

File Click Choose File to browse for the driver file.

5. Click Save. The driver uploads and displays in the Repository: OS Drivers window.

The driver is ready to be applied to a configuration profile.

Apply a driver to a hardware profile

Follow these steps to apply an uploaded driver to a hardware profile.

Prerequisites

You must first upload an operating system before performing this task.

Steps

1. From the left-side menu, select Deployment > Hardware Profile to view the Deployment: Hardware Profile page.

2. Select an existing hardware profile.

3. From the Actions menu, select Edit. The Edit Hardware Profile window is displayed.

4. Under OS Drivers, click Add. The Add OS Driver window is displayed.

5. Select a driver from any of the uploaded drivers.

6. Click Add to add the driver.

7. Click Save to apply the driver to your hardware profile.

View drivers installed on a device

Follow these steps to view details for a hardware profile that is assigned to a device.

Steps

1. From the left-side menu, select Inventory.

2. Select the IP address of the device to which you applied the profile with the custom driver.

3. Click View Device.

4. Select Overview from the View menu. The installed driver information is displayed on the OS Drivers card.

Deployment 113

Stack deployment Stack deployment lets you create profiles that manage the deployment of cloud stacks. Bare Metal Orchestrator supports the deployment of VMware Telco Cloud Platform (TCP) version 2.0, Wind River stack deployment, Red Hat OCP stack deployment, and VMware Tanzu Kubernetes Grid (TKG).

Deploy a cloud stack

You can deploy a VMware TCP stack.

Prerequisites

Buy and install licenses for all components in the VMware TCP software bundle. Deploy a DNS server, an NTP server, and a web server. Install ESXi 7 on all servers using a hardware profile. See the Bare Metal Orchestrator CLI Users Guide. Browse to ~/samples/tcp/stacks while logged into Bare Metal Orchestrator as the Dell user. Download these three

predefined configuration templates for the installer, stack, and host: TCPConfig.json, InstallerConfig.json and AddHosts.json. Edit the three files to add the necessary configuration information for your stack deployment.

Steps

1. From the left menu, select Deployment > Stack Deployment to deploy a cloud stack.

2. From the Actions drop-down list, select Create. The Create Stack Deployment window is displayed.

3. Complete these fields to deploy a VMware TCP stack:

Table 74. Stack deployment fields

Field Description

Blueprint Details

Name Descriptive name for the stack deployer.

Type Type of deployment. Select VMware TCP from the menu.

Version The version number. Select a version from the menu, such as 2.0.

Deploy TKG Check this box to deploy TKG. See Deploy TKG clusters.

NOTE: You can deploy the TCP stack and the TKG cluster simultaneously.

4. Configure and install a blueprint. See Configure the Blueprint Installer for TCP.

5. Configure DNS and Server Details. See Set the domain name for a cloud stack and Set server details for a cloud stack.

6. Add the vLAN ID in the VLAN ID field.

7. For server credentials, choose either Set for all servers or Set individually, and then click Set Credentials. In the Set Credentials window, add a username and password for one or more servers and click Save.

NOTE: If you add additional servers using Set Server Details after credentials have been set, you must return to

Server Credentials to add the new servers. Alternatively, you can use the Set for all servers option.

8. Click Deploy.

9. To edit or delete an existing stack deployer, select it under Deployment > Stack Deployment and choose Edit or Delete from the Actions drop-down list.

Configure the Blueprint Installer for TCP

Follow these steps to configure the blueprint installer. A blueprint is a model of the application topology and its operations implementation.

Steps

1. Click View/Edit. The Blueprint Installers window is displayed.

114 Deployment

2. Complete these fields: IP: Enter the installer IP address. Username: Enter the installer username. Password: Enter the installer password.

3. Click Choose File to upload an installer Config File, a Stack Config file, and a Host Profile file.

NOTE: If you use Firefox, click Browse instead of Choose File.

4. Click Save to save all blueprint configuration settings.

Set the domain name for a cloud stack

Follow these steps to set the domain name for a cloud stack.

Steps

1. From the Stack Deployment page, click Set Domain Name and enter a domain name.

2. Click Add New to add multiple domain entries. Click the minus icon to delete a domain entry.

3. Click Save to save all DNS settings.

Set server details for a cloud stack

Follow these steps to configure server details for a cloud stack.

Steps

NOTE: The server details that you enter here must match the server details in the host configuration file. In addition, Bare

Metal Orchestrator must manage each server, and all servers must have ESXi 7 installed on it.

1. From the Stack Deployment page, click Set Server Details. The Server Details window is displayed.

2. Click Add New.

3. Complete these fields: Server Name: Enter the server name. IP Address: Enter the server IP address. DNS Name: Enter the server DNS name.

4. Click Add New to add multiple server entries. Click the minus icon to delete a server entry.

5. Click Save to save all server details.

NOTE: Click edit to make any additional changes.

Deploy a Wind River stack

You can deploy a Wind River stack in Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Deployment > Stack Deployment.

2. From the Actions drop-down list, select Create. The Create Stack Deployment window is displayed.

3. Complete these fields: Enter a stack name in the Name field. Select the stack type Wind River from the Type menu. Select the stack version number from the Version menu.

4. Configure the Blueprint Installer. See Configure Blueprint Installer for Wind River.

5. Set Server Details. See Set Server Details for Wind River.

6. Click Deploy to begin the stack deployment.

Deployment 115

Configure Blueprint Installer for Wind River

Follow these steps to configure the blueprint installer. A blueprint is a model of the application topology and its operations implementation.

Steps

1. Click View/Edit. The Blueprint Installers window is displayed.

2. Complete these fields: Site: Enter the domain or site name. Installer IP: Enter the installer IP address. Username: Enter the installer username. Password: Enter the installer password.

3. Click Upload to upload an installer Config File.

4. Click Upload to upload a Stack Config File.

5. Click Add New again to add multiple installer entries. Click the minus icon to delete an installer entry.

6. Click Save to save all blueprint configuration settings.

Set Server Details for Wind River

Follow these steps to configure server details for a Wind River stack.

Steps

1. Under Server Details, click View/Edit. The Server Details window is displayed.

2. Click Add New.

3. Complete these fields: Server Name: Enter the server name. Domain: Enter the domain name. Role: Enter the role type.

4. Click Add New to add multiple server entries. Click the minus icon to delete a server entry.

5. Click Save to save all server details.

Deploy a Red Hat OCP stack

You can deploy a Red Hat OCP stack in Bare Metal Orchestrator.

Steps

1. From the left-side menu, select Deployment > Stack Deployment.

2. From the Actions drop-down list, select Create. The Create Stack Deployment window is displayed.

3. Complete these fields: Enter a stack name in the Name field. Select the stack type RHOCP from the Type menu. The Version is automatically filled in and only 4.10 is supported in

this release.

4. Configure the Blueprint Installer. See Configure blueprint installer for Red Hat OCP.

5. Set Server Details. See Set server details for Red Hat OCP.

6. Click Deploy to begin the stack deployment.

116 Deployment

Configure blueprint installer for Red Hat OCP

Follow these steps to configure the blueprint installer. A blueprint is a model of the application topology and its operations implementation.

Steps

1. Click View/Edit. The Blueprint Installers window is displayed.

2. Complete these fields: IP: Enter the installer IP address. Username: Enter the installer username. Password: Enter the installer password. Installer Type: RHACM is hard-coded.

3. Click Choose File to upload a Config File.

4. Click Choose File to upload a Pre Install File.

NOTE: Post Install File is an optional upload.

5. Enter a Domain Name and upload a Stack Config file.

6. Click Add New again to add multiple entries. Click the minus icon to delete an entry.

7. Click Save to save all blueprint configuration settings.

Set the domain name for Red Hat OCP

Follow these steps to set the domain name for Red Hat OCP.

Steps

1. From the Stack Deployment page, click Set Domain Name and enter a domain name.

2. Click Add New to add multiple domain entries. Click the minus icon to delete a domain entry.

3. Click Save to save all DNS settings.

Set server details for Red Hat OCP

Follow these steps to configure server details for a Red Hat OCP stack.

Steps

1. From the Stack Deployment page, click Set Server Details

2. Click Add New.

3. Complete these fields: Server Name: Enter the server name. Domain: Enter the domain name. Role: Enter the role type.

4. Click Add New to add multiple server entries. Click the minus icon to delete a server entry.

5. Click Save to save all server details.

Deploy TKG clusters

Deploy one or more TKG clusters in Bare Metal Orchestrator.

Prerequisites

Before deploying a TKG cluster, you must:

Deploy a TCP stack. It is recommended that you deploy the TCP stack and the TKG cluster simultaneously. See Deploy a cloud stack.

Configure the Installer Configuration, Stack Configuration, and Host Configuration files for the TCP installer.

Deployment 117

Configure the TKG cluster template file.

Steps

1. From the left menu, select Deployment > Stack Deployment to deploy a cloud stack.

2. From the Actions drop-down list, select Create.

3. Complete these fields to deploy a VMware TCP stack:

Table 75. Stack deployment fields

Field Description

Blueprint Details

Name Descriptive name for the stack deployer.

Type Type of deployment. Select VMware TCP from the menu.

Version The version number. Select a version from the menu, such as 2.0.

Deploy TKG You must check this box to deploy TKG. See Deploy TKG clusters.

4. Configure and install a blueprint. See Configure the Blueprint Installer for TCP.

5. Configure DNS and Server Details. See Set the domain name for a cloud stack and Set server details for a cloud stack.

6. Add the vLAN ID in the VLAN ID field.

7. For server credentials, choose either Set for all servers or Set individually, and then click Set Credentials. In the Set Credentials window, add a username and password for one or more servers and click Save.

NOTE: If you add additional servers using Set Server Details after credentials have been set, you must return to

Server Credentials to add the new servers. Alternatively, you can use the Set for all servers option.

8. Configure TKG templates. See Configure a TKG template.

9. Configure TKG clusters. See Configure a TKG cluster.

10. Click Deploy to begin TKG cluster deployment.

NOTE: A successful TKG deployment cannot be edited or deleted.

Configure a TKG template

Configure a TKG template before you create a TKG cluster.

Steps

1. Under TKG Deployment Templates, click View/Edit. The TKG Deployment Templates window is displayed.

2. Complete these fields:

Table 76. TKG template fields

Field or Button Description

Template Type Select a template type from the menu. Choices are Management, Shared Service, or Workload.

Template Name Enter a TKG template name.

Description Click the document icon next to Template Name and enter a template description in the Description field. Click Save to save the description.

JSON File Click Upload to upload the cluster template file.

Add a Template Click Add a Template to add an additional cluster template entry. Repeat this step to add multiple cluster templates. Click the minus icon to delete a cluster template entry.

3. Click Save to save one or more TKG templates.

118 Deployment

Configure a TKG cluster

Configure a TKG cluster after you set up a TKG template.

Steps

1. Under TKG Deployment Clusters, click Add. The TKG Deployment Clusters window is displayed.

2. Complete these fields:

Table 77. TKG cluster fields

Field or Button Description

Add a Cluster Click Add New Cluster to add a TKG cluster definition. Repeat this step to add multiple cluster definitions. Click the minus icon to delete a cluster entry.

Cluster Type Select a cluster type from the Cluster Type menu. Choices are Management, Shared Service, or Workload.

Name Enter a TKG cluster name.

Template Select a cluster template from the Template menu.

Target Domain Enter the cluster target domain.

Cluster Password Enter a cluster password. Click the eye icon to view the password.

Endpoint IP Enter the cluster IP address.

DNS Server Enter the DNS server information.

Management Cluster Enter the Management Cluster information. NOTE: The Management Cluster field is visible only if the cluster type selected is either a Shared Service or Workload cluster.

Reinitialize stack deployment

You can reinitialize stack deployment.

About this task

Perform this process if a stack fails in the middle of a deployment.

Steps

1. From the left-side menu, select Deployment > Stack Deployment.

The Stack Deployment page displays with a list of deployments.

2. Select the deployment that you must reinitialize.

3. From the Actions menu, select Reinitialize. The system displays a message asking you to confirm reinitialization of this deployment.

4. Click OK. The system displays a success message.

Deployment 119

Site Management View and manage sites and their associated inventories.

Topics:

Sites overview Manage sites View all sites View sites on a map Add a site Edit site details Set up a site for autodiscovery Set up a site for DHCP relay Discover a device with IP scan Viewing site inventory Delete a site Reinitialize a site

Sites overview A site is a physical location where devices are deployed.

The following sites are used in Bare Metal Orchestrator:

Global Controller site: The GC, or GC site, is the default site that is created when Bare Metal Orchestrator is deployed. The GC site constitutes core components and site components. The GC can manage all sites and devices that are associated with it. It enables horizontal scaling and allows a single site to scale by creating one or more sites called remote sites.

Remote sites: You can create remote sites in different locations and each site can manage devices that are associated with it. For example, consider if you deploy four sites, one each at Santa Clara, Hopkinton, Durham, and Miami. All sites have separate sets of physical devices to manage. The GC manages all of them and is deployed in Austin. When you create sites, site components are deployed on each site.

You can:

Add worker nodes for creating sites. Create remote sites. View and update the site metadata. Monitor the health, operation, and status of your sites. Reinitialize a site that has failed. Delete remote sites. Manage device configurations and devices that are associated with the sites. Create hardware profiles on the Global Controller and apply them to servers associated with different sites. Update the DHCP configuration on sites.

NOTE: The term device includes servers and switches unless otherwise stated.

High-level site creation workflow

The high-level flow for creating sites is as follows:

1. Add worker nodes. For more information, see the Bare Metal Orchestrator Installation Guide. 2. Verify if the nodes are created successfully. For more information, see Viewing Nodes in the Bare Metal Orchestrator

Command Line Interface User's Guide.

6

120 Site Management

3. Create remote sites. For more information, see Creating remote sites in the Bare Metal Orchestrator Command Line Interface User's Guide.

NOTE: The site controller and site components are installed when a remote site is created.

4. Verify if the sites are created successfully. For more information, see Viewing sites in the Bare Metal Orchestrator Command Line Interface User's Guide.

5. Onboard servers at the sites.

For more information about configurations that Bare Metal Orchestrator supports, see Managing server configurations in the Bare Metal Orchestrator Command Line Interface User's Guide.

Manage sites You can perform site management tasks from the Sites page.

Click the Sites link in the left-side panel to view the Sites page.

The View drop-down list allows you to switch between the following views:

List View (default)In this view, the Selected indicator appears in the row of the selected site. Map View

The Actions drop-down list allows you to perform the following actions for a site:

Create Edit Delete

NOTE: The Actions drop-down list is only available in List View.

The Filter drop-down list allows you to filter the list of sites by the following fields:

City State Country Latitude Longitude

NOTE: The Clear option only clears filters and does not clear any keywords in the Search bar.

The Search bar allows you to search for a specific site.

View all sites Follow these steps to view a list of all sites.

Steps

1. From the left-side menu, click Sites to view the Sites page.

2. From the View drop-down list, select List View.

The site name and location information are displayed in the following table:

Table 78. Site name and location information fields

Field Description

Select the check box in the row to choose one or more sites.

Name Descriptive name of the site. Enter a site name of up to 253 characters.

Site Health Displays the health status of the site (such as OK and Critical).

Site State Displays the state of the site (such as Ready).

Device Count The total number of devices at a given site.

Site Management 121

Table 78. Site name and location information fields (continued)

Field Description

Site ID User-defined, descriptive ID. This field accepts any character.

Type Indicates whether the site is a remote site or the global site.

Location Location name.

Address Street address for the location.

City City of the location.

State State of the location.

Country Country of the location.

Latitude Latitude coordinates for the location.

Longitude Longitude coordinates for the location.

View Site When you hover over a row, this button is displayed, allowing you to view inventory information for the site.

3. Optional: To filter the list of sites, click Filter to display the list of available filter criteria.

NOTE: To sort sites by a category, click the arrow icon next to the field name in the table.

View sites on a map You can view the location of the various sites on a map.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. From the View drop-down list, select Map View.

3. Optional: To filter the list of sites, click Filter to display the list of available filter criteria.

4. To select a site on the map, hover over the location icon of the site until its name displays.

Figure 24. Select site on map

5. Click a location icon for the site on the map. A dialog box displays the site name and the number of devices that it manages along with View and Edit buttons.

122 Site Management

Figure 25. Site information

6. Optionally, you can do one of the following: Click View to display inventory information for the site devices and their components. See Viewing site inventory. Click Edit to edit site details and metadata. See Edit site details.

Add a site You can add a remote site to the list of available sites.

Prerequisites

If setting up a site for auto discovery or DHCP relay, the site devices must first be configured to use DHCP. Otherwise, they cannot be autodiscovered or participate in DHCP relay.

Worker nodes at the sites must be joined to the Global Controller.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. From the View drop-down list, select List View.

3. Click the Actions drop-down list and select Create.

4. In the Add Site dialog box, enter the required information as needed.

NOTE: Required fields display in red, and read-only fields do not allow text entry. All fields are editable unless otherwise

indicated.

Table 79. Site parameters

Field name Description and values

Name The unique name for the site. This field is required and is not editable after site creation.

Node Name The worker node that is linked to this site. This field is not editable after site creation.

Location Location name. This field is required and is not editable after site creation.

Site ID User-defined, descriptive ID. This field accepts any character.

Type The type of site. This field is not editable after site creation.

Address Street address for the location. This field is required.

City City of the location. This field is required.

State State of the location. This field is required.

Country Country of the location. This field is required.

Latitude Use positive and negative decimal numerals. Do not use degrees or cardinal directions.

Site Management 123

Table 79. Site parameters (continued)

Field name Description and values

Longitude Use positive and negative decimal numerals. Do not use degrees or cardinal directions.

NOTE: Sites require both latitude and longitude information to display on the map.

Edit site details You can edit site details and metadata.

Prerequisites

If setting up a site for auto discovery or DHCP relay, the site devices must first be configured to use DHCP. Otherwise, they cannot be autodiscovered or participate in DHCP relay.

Kubernetes worker nodes at the sites must be joined to the Global Controller.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. From the View drop-down list, select List View.

3. Select the check box for the site that you want to edit.

4. Click the Actions drop-down list and select Edit.

5. Edit the fields in the Edit Site page as needed.

Table 80. Site parameters

Field name Description and values

Name The unique name for the site. This field is required and is not editable after site creation.

Node Name The worker node that is linked to this site. This field is not editable after site creation.

Location Location name. This field is required and is not editable after site creation.

Site ID User-defined, descriptive ID. This field accepts any character.

Type The type of site. This field is not editable after site creation.

Address Street address for the location. This field is required.

City City of the location. This field is required.

State State of the location. This field is required.

Country Country of the location. This field is required.

Latitude Use positive and negative decimal numerals. Do not use degrees or cardinal directions.

Longitude Use positive and negative decimal numerals. Do not use degrees or cardinal directions.

NOTE: Both latitude and longitude must be provided for the site to display on the map.

6. Click Save to continue. A status message confirms the site edits.

124 Site Management

Set up a site for autodiscovery You can optionally configure a site for autodiscovery.

Prerequisites

If setting up a site for auto discovery or DHCP relay, the site devices must first be configured to use DHCP. Otherwise, they cannot be autodiscovered or participate in DHCP relay.

Worker nodes at the sites must be joined to the Global Controller.

About this task

Bare Metal Orchestrator deploys DHCP in Server mode. When a new device (server) is plugged in, the Bare Metal Orchestrator DHCP server automatically assigns an IP address from a pool of available addresses. It does this instead of using static IP addressing.

Steps

1. From DHCP Settings, click Edit.

2. Select Auto from the Auto Discovery drop-down list.

3. Select Server from the Deploy Mode drop-down list.

NOTE: Auto discovery is available only when the DHCP server is in Server mode.

4. In the Subnets section, click the icon in the Actions column to add a subnet entry to the list.

5. Complete these fields for the subnet:

Table 81. Subnet fields

Field Description

Default Lease The default duration of the lease timer.

Max Lease The maximum duration of the lease timer.

Netmask The network mask.

Broadcast Address IP address for broadcasts.

Routers IP addresses for routers on the subnet of the client listed in order of preference.

Subnet Mask The mask used for this subnet.

Subnet IP address of this subnet.

6. You can specify an IP pool access list for each subnet. Add an entry to the access list by clicking the icon (in the Actions column).

7. Complete these fields for the access list:

Table 82. Access list fields

Field Description

Allow Members Specifies the vendor class of servers that are given an address from the IP address pool. Enter one of the identifiers from the Vendor Class Identifier field. For multiple identifiers, enter this as comma-separated. For example, iDRAC, iLO. For PXE boot, enter PXEClient.

Deny Members Specifies the vendor class of servers that are not given an address from the IP address pool. Enter one of the identifiers from the Vendor Class Identifier field. For multiple

Site Management 125

Table 82. Access list fields (continued)

Field Description

identifiers, enter this as comma-separated. For example, iDRAC, iLO. For PXE boot, enter PXEClient.

Start Range First IP address of the pool range.

End Range Last IP address of the pool range.

8. Click Save to update the subnet settings.

9. Enter this additional information:

Table 83. Other fields

Field Description

Interfaces Enter a comma-separated list of interfaces to configure for Server mode.

Vendor Class Identifier Enter the identifiers to use in the Allow Members and Deny Members fields of the subnets. For multiple identifiers, enter this as comma-separated. For example, iDRAC, iLO. For PXE boot, enter PXEClient.

Domain Enter the name of the domain.

DNS Enter the address of the Domain Name Server (such as 8.8.8.8).

Default Lease Time Enter the default duration of the lease timer.

Max Lease Time Enter the default maximum duration of the lease timer.

Additional DHCP Config Enter any additional DHCP configuration information. You can specify multiple configuration parameters (separated by semicolons).

In-Band IP A private IP address used to configure PXE In-Band VLAN.

Boot Size The primary boot image size to download from the TFTP server. This value is calculated from the boot file size in bytes divided by 512.

10. Optional: Click Save to complete auto discovery setup.

Set up a site for DHCP relay You can optionally configure a site for DHCP relay.

Prerequisites

If setting up a site for auto discovery or DHCP relay, the site devices must first be configured to use DHCP. Otherwise, they cannot be autodiscovered or participate in DHCP relay.

Worker nodes at the sites must be joined to the Global Controller.

About this task

Bare Metal Orchestrator deploys a DHCP server in Relay mode. The Bare Metal Orchestrator DHCP server does not allocate IP addresses. It functions as a relay agent and becomes a proxy, forwarding requests and replies between a DHCP server and other devices at the site.

Steps

1. From DHCP Settings, click Edit.

126 Site Management

2. Select None from the Auto Discovery drop-down list.

3. Select Relay from the Deploy Mode drop-down list.

4. In the Interfaces field, enter a comma-separated list of all interfaces that are part of the DHCP relay process (configured in relay mode).

5. In the Forward IP Address field, enter the address of the DHCP server where messages should be forwarded.

6. Click Save to complete DHCP relay setup.

Discover a device with IP scan You can automatically discover one or more devices by scanning a range of IP addresses. This autodiscovers devices on the network that are eligible for onboarding. Only secure ports are scanned on the subnet.

Prerequisites

All required ports are open, see Firewall port requirements for more information.

About this task

NOTE: Add credentials for the network device to the cred.yaml file before scanning the network.

Steps

1. From the left-side menu, select Sites.

The Sites page opens.

2. Select a site by checking the box next to the site name. You can only select one site at a time to scan.

3. From the Actions menu, select IP Scan. The Set Up Device Discovery page opens.

4. Enter these fields to schedule a scan:

Table 84. IP scan fields

Field Description

IP Start Range Starting IP address for a range of IP addresses. Separate an address range with commas. Use this setting with IP End Range.

IP End Range Ending IP address for a range of IP addresses. Separate an address range with commas. Use this setting with IP Start Range.

CIDR An IP network specified in CIDR format. For example, 192.68.1.1/27.

Hostname(s) A user-defined, comma-delimited list of specific IP addresses to scan.

Schedule Schedule the frequency of IP scans. Only one IP scan can be active for a site at any time. The current scan must end before the next scan starts. The minimum scan frequency is once every hour.

NOTE: This parameter is required if any of the previous fields are filled in.

5. Click Save to kick off the scan process. The system returns to the main Sites page. To view the scan status, reselect the site and select Actions > IP Scan to view the current scan status.

NOTE: Discovery History displays the number of discovered devices and their respective IP addresses.

Site Management 127

Figure 26. Discovery history

IP Scan example

Example settings for IP scan are shown below:

Figure 27. IP scan settings

128 Site Management

Reset a scan

You can reset scan settings for a site. This action clears all settings for a previously scanned site.

Steps

1. From the left-side menu, select Sites.

The Sites page opens.

2. Select a site by checking the box next to the site name. You can only select one site at a time.

3. From the Actions menu, select IP Scan. The Set Up Device Discovery page opens.

4. Click Reset. The system asks for confirmation that you want to reset the scan.

5. Click Yes. All settings are cleared from fields, and the scan job is deleted.

Viewing site inventory View the inventory information for site devices and their components.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. Click the Select check box for the site that you want to view.

3. Hover over the row for the selected site until the View Site button appears (at the end of the row).

4. Click View Site to display the inventory information for a site.

Delete a site You can delete a remote site from the list of available sites.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. From the View drop-down list, select List View.

3. Click the Select check box for the site to be deleted.

4. Click the Actions drop-down list and select Delete.

5. On the Delete confirmation dialog, click Yes to continue. A status message confirms the site deletion.

Reinitialize a site Reinitialize a site that has failed.

Steps

1. From the left-side menu, click Sites to display the Sites page.

2. From the View drop-down list, select List View.

3. Click the Select check box for the site to be reinitialized.

4. Click the Actions drop-down list and select Reinitialize Site. The system displays a message asking you to confirm whether you want to reinitialize the selected site.

5. Click Reinitialize to restore the failed site.

Site Management 129

Tenants Create and manage tenants in Bare Metal Orchestrator

Topics:

Multitenancy overview Create a tenant View tenant Edit a tenant Delete a tenant Reinitialize tenant

Multitenancy overview Multi-tenancy is a distributed Bare Metal Orchestrator architecture where a single instance of Bare Metal Orchestrator runs on a server and serves multiple tenants. A tenant is a group of users who share common access and specific privileges to the software instance. This includes its data, configuration, user management, resources, tenant-individual functionality, and nonfunctional properties.

Multitenancy allows you to:

Create, edit, view, or delete tenants. Add users to a given tenant. Edit or delete users who are associated with the given tenant. Assign or release a server from the given tenant.

This table describes tenant roles.

Table 85. Tenant roles

Role Permissions

Tenant Admin Read and write privileges to all tenant-related operations and resources, within the assigned tenant.

Can assign more users to the tenant.

Can view or describe the assigned tenant.

Can view all servers and switches in the pool of unassigned resources and the assigned tenant.

Can view all ISO media and firmware media in the default tenant.

Can view all sites in the pool of unassigned resources.

Can transfer servers and switches from the pool of unassigned resources to the assigned tenant.

Can release servers and switches from the assigned tenant to the unassigned resources pool.

CAUTION: Note the following before relinquishing a server to the unassigned resources pool:

The system runs the baseline-profile against the server and returns it to a clean state. The baseline-profile ships with Reinitialize Drives selected, so when a server returns to the unassigned resources pool, the server disks are wiped. This action may cause data loss.

To avoid erasure of server disks, edit the baseline-profile, de-select Reinitialize Drives, and click Save.

Cannot edit servers or switches of other tenants.

Cannot create users or any resources such as servers, switches, ISO media, firmware media, and so on.

Cannot delete any tenant or resources.

7

130 Tenants

Table 85. Tenant roles (continued)

Role Permissions

Tenant Reader Read-only access to Bare Metal Orchestrator resources, within the assigned tenant.

Can view all servers in the global pool and the assigned tenant.

Can view all ISO media and firmware media in the global pool.

Cannot create, edit, or delete tenants or resources.

Create a tenant You can create a tenant with single or multiple tenant administrators.

About this task

Follow these steps to create a tenant:

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. From the Actions drop-down, select Create. The Create Tenant window opens.

3. Enter a Name for this tenant.

4. Click Save to apply your changes.

Create a tenant admin

Follow these steps to create a tenant admin user:

Steps

1. Click the plus sign to open a tenant admin field.

2. Select a user from the User Name drop-down.

3. Optional: Repeat these two steps to create additional tenant admins.

4. Click Save to apply your changes.

View tenant Follow these steps to view a tenant.

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. Enter a search term to narrow your view options.

Tenants 131

Edit a tenant Follow these steps to edit a tenant.

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. Select the tenant that you want to edit.

3. From the Actions drop-down, select Edit. The Edit Tenant window opens.

4. Make changes as required.

5. Click Save. The system displays a success message for this operation.

Delete a tenant user

Follow these steps to remove a tenant user.

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. Select the tenant where you want to remove one or more users.

3. From the Actions drop-down, select Edit. The Edit Tenant window opens.

4. Click the minus sign next to the user that you want to delete.

5. Click Save. The system displays a success message for this operation.

Delete a tenant Follow these steps to delete a tenant.

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. Select the tenant that you want to delete.

3. From the Actions drop-down, select Delete. The system displays a message to confirm deletion of the selected tenant.

4. Click Yes. The system confirms the tenant deletion.

132 Tenants

Reinitialize tenant Follow these steps to reinitialize a tenant.

About this task

This process brings the tenant back to the ready state and synchronizes the server count. This action forces reconciliation for a tenant on failure or forcibly refreshes the resource status.

If a release server request fails and the tenant moves to a failed state, you can reconcile the tenant with this flag once the issue is fixed. The process that caused the tenant to fail is reattempted and if successful, the tenant moves to the Ready state. Another use for this option is force refreshing the status even when a tenant is Ready. This is useful when the number of servers belonging to a tenant is out of sync. Reinitialize causes the number of servers belonging to a tenant to be recalculated.

Steps

1. From the left-side menu, select Tenants .

The Tenants page opens.

2. Select the tenant that you want to reinitialize.

3. From the Actions drop-down, select Reinitialize Tenant. The system displays a message to confirm reinitialization of the selected tenant.

4. Click Yes. The system displays a success message for this operation.

Tenants 133

Events You can view Bare Metal Orchestrator event success and failure information on this page.

Topics:

View events Filter events

View events Follow these steps to view event status messages on Bare Metal Orchestrator.

About this task

Bare Metal Orchestrator makes get requests every 15 minutes for events. This is the default setting, and it is not configurable. However, if you click the event notification icon on the top right, you can manually request the events to display the 5 most recent events.

NOTE: Event links are read-only in the Event Notification panel. See Event notification panel for more information.

Steps

1. From the left-side menu, select Events .

The Events Page opens.

Figure 28. Events page

2. Click a row to display the event information panel (right side).

8

134 Events

Table 86. Event field descriptions

Field Description

Icon The icon indicates the severity of the event: Normal (green) Warning (yellow) Critical (red) Info (question mark)

Timestamp Date and time when the event occurred.

Transaction ID Not supported in this release.

Transaction Progress Not supported in this release.

Transaction State Not supported in this release.

Resource Type Type of resource that the event occurred on, such as a hardware profile or a site.

Resource Name Name of the resource that the event occurred on, such as baseline-profile or site-master.

Message Event message details.

3. Filter the event results further. See Filter events for more information.

NOTE: You can also search for event message details using the Search box.

Event notification panel

This panel displays a read-only list of the 5 most recent events.

Click the event notification icon at the top right of the dashboard to display the Event Notification panel. Click View All to display the Events page with a list of events.

Events 135

Figure 29. Events notification panel

Filter events Follow these steps to filter event messages.

Steps

1. From the left-side menu, select Events . The Events page is displayed.

2. Click the Filter menu. The Event Filter dialog box is displayed.

3. Specify one or more filtering options:

Table 87. Event filter options

Field Description

Type Select one of these event types from this menu: Warning, Info, Critical, or Normal.

Transaction ID This is not supported in this release.

136 Events

Table 87. Event filter options (continued)

Field Description

Resource Type Enter a resource type, such as HardwareProfile or Site.

Resource Name Enter a resource name, such as baseline-profile or site-master.

4. Click Apply. The Events page is displayed with filtered results.

Events 137

Users You can create, view, edit, or delete users in Bare Metal Orchestrator.

Topics:

User management Create a user View users Edit a user Delete a user

User management You can perform these user management tasks:

CreateAdd a user account. See Create a user. ViewView a list of existing users. See View users. EditEdit a list of existing users. See Edit a user. DeleteDelete a user account. See Delete a user.

Create a user Follow these steps to create a user account.

Steps

1. From the left-side menu, select Users .

The Users Page opens.

2. From the Actions drop-down, select Create.

3. Complete these fields as required:

Table 88. User settings

Field Description

Username Name of the user. This setting is required. NOTE: For Supermicro and HPE iLO servers, usernames cannot contain special characters.

Password Password of the user. This setting is required.

Email Email address of the user

Group Role that is assigned to a user, including: Global Admin Support Admin Operator Global Reader

This setting is required.

NOTE: You can select multiple roles for a user by clicking each required role.

9

138 Users

Table 88. User settings (continued)

Field Description

First Name First name of the user

Last Name Last Name of the user

4. Click Save.

Roles and Permissions table

The following table describes the available user roles and the assigned permissions for each role.

Table 89. Roles and permissions

Role Permissions

Global Admin Read and write privileges to all Bare Metal Orchestrator resources across all clusters, pods, servers, sites, hardware profiles, and so on.

Can create, edit, and delete users.

Can assign and edit user roles.

Cannot create, edit, or delete clusters.

Support Admin Can perform backup and restore operations.

Can put Bare Metal Orchestrator in Maintenance mode.

Operator Read and write privileges on all Bare Metal Orchestrator resources this user can access across the cluster.

Global Reader Read-only access on all Bare Metal Orchestrator resources across all clusters, pods, servers, sites, hardware profiles, and so on.

NOTE: If a user is assigned multiple roles, the role with highest privileges is applied.

View users You can view a list of users and the roles that are assigned to them.

Steps

1. From the left-side menu, select Users .

The Users Page opens.

2. Look for a specific user by entering the username in the search box. You can also sort users according to username or role.

Edit a user Follow these steps to edit an existing user account. Only global admins can edit users.

Steps

1. From the left side menu, select Users .

The Users page is displayed.

2. Click the checkbox next to the user that you want to edit.

Users 139

3. From the Actions menu, select Edit and make the required changes.

4. Click Yes . The system confirms the user account changes.

Delete a user Follow these steps to delete one or more user accounts.

Steps

1. From the left-side menu, select Users .

The Users Page opens.

2. Click the checkbox next to the user that you want to delete. Repeat for additional users.

3. From the Actions drop-down, select Delete. The system displays a message asking you to confirm deletion of one or more user accounts.

4. Click Yes. The system confirms the deletion.

140 Users

Logs You can generate and view system logs on the Logs page.

Topics:

Logs overview

Logs overview This section describes system logging. You can access Logs from the left-side menu.

The log headings are as follows:

Table 90. System log description

Column Name Description

Message A descriptive message.

Log Level The log level at which the message was logged. For example, DEBUG.

Service Name Name of the service.

Site Site that generated the message.

Timestamp Date and time that the message occurred.

You have these options to narrow the list of log entries:

FilterFilter the search results by severity level and site. SearchPerform a search for the specified text.

You can change the columns that are displayed in the Logs table. Click the Ellipsis icon in the far-right above the Logs table to select the columns to show or hide.

10

Logs 141

Settings Use the Settings page to:

View, credit, edit, or delete BMC credentials. Backup and restore data. Copy or view API token. Enable or disable server maintenance mode

Topics:

BMC credentials overview Backup and restore Downloads Maintenance mode

BMC credentials overview

BMC credentials are used for two reasons:

1. If you create a server without specifying credentials, the system tries credentials on this page in sequence to identify one that works.

2. During autodiscovery, when an IP address is assigned to an iDRAC that is configured to use DHCP, Bare Metal Orchestrator tries each of these credentials in sequence to find a credential that works on the autodiscovered server.

View BMC credentials

You can view a list of all current BMC credentials within Bare Metal Orchestrator. From the left-side menu, click Settings. The system displays all current BMC credentials (username and password).

Create BMC credentials

Create additional BMC accounts.

Steps

1. From the left-side menu, click Settings.

A list of current BMC accounts display.

2. Click the plus icon to the right of the Password field.

3. In the Name field, enter a username for the account.

4. In the Password field, enter a password for the account.

Optionally, you can click the eye icon to view the password.

5. Repeat these steps to create additional BMC credentials.

6. Click Save to apply your changes.

11

142 Settings

Edit BMC credentials

Edit the credentials of an existing BMC account.

Steps

1. From the left-side menu, click Settings.

2. Edit the username of an account in the Name field.

3. Edit the password of an account in the Password field.

Optionally, you can click the eye icon to view the password.

4. Click Save to apply your changes.

Delete BMC credentials

Delete a BMC user account.

Steps

1. From the left-side menu, click Settings.

2. Click the minus icon to the right of the account credentials that you want to delete.

3. Click Save to apply your changes.

Backup and restore This section describes the backup and restore process.

The Bare Metal Orchestrator Backup and Restore function uses a Backup Controller (Velero) service that runs in the RKE2 cluster master node. The Backup Controller takes snapshots of the cluster ETCD database and supports both on-demand and scheduled backups. Backup files are valid for up to 30 days.

NOTE: Dell Technologies recommends that you change the backup file location to an external S3 storage location. Any

Velero-supported S3 storage provider is supported as an external backup location.

Limitations

Observe the following:

Save backups to only one backup storage location. Backup files expire one month after creation. You cannot use expired files to restore the cluster. If using an external S3 storage location for the backup files, the server hosting the external backup store must support SSL. When restoring a cluster using a backup file: 1. The number of nodes in the new cluster must be equal to or greater than the number of nodes that were in the original

cluster. 2. Objects that exist in the cluster are not overwritten unless they have been modified.

NOTE: When scheduled backups are configured, periodically check the free space available in the MinIO S3 backup

location, and manually remove backup files to free up space if required. Remove expired backup files that are more than

one month old.

Create a manual backup

This process describes how to create and run a manual backup. The system takes an immediate snapshot of the ETCD database of the Global Controller and saves the backup file to the MiniIO S3 storage location.

Steps

1. Click Settings on the left-side menu.

Settings 143

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays.

3. From the Actions drop-down, select Backup Now. The Create Backup window opens.

NOTE: The Backup Namespace field is read-only and displays velero.

4. Enter a backup name in the Name field. The backup name must contain lowercase alphanumeric, '-', or '.' characters only and must end with an alphanumeric character.

5. Click Save to apply the name change and start the backup process. The system returns to the Backup & Restore screen and displays a status of In Progress.

View backup list

You can view current backups and scheduled backups.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays with a list of current and scheduled backups.

3. View these details about a backup:

Table 91. Backup details

Field Description

Action Describes the action that is performed on a backup, such as Scheduled Backup, Restore, and so on.

Last Run Time and date when the backup was performed.

Status Status of the backup process, such as Running, Completed, or Failed. A successfully completed backup also lists the number of items in the backup file.

NOTE: Refresh the page to view the most current progress of a backup or restore operation.

NOTE: Change the pagination items per page if there is a long list of backup files.

Restore a backup file

You can restore all the objects and persistent volumes from a previously created backup. These objects include Global Controller and worker nodes, site configurations, users and role information, and related metadata.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays with a list of backups.

3. Click the check box next to the backup file that you want to restore. You can only restore one backup file at a time.

4. From the Actions drop-down, select Restore from Backup. The system opens a Restore from Backup dialog and states that restoring a backup may take several minutes and asks whether you want to proceed.

5. Click Yes to start the restore process. If the process succeeds, the system displays a success message.

6. Click the Restore History tab to view status on the restore operation. The table below describes the Restore History fields.

144 Settings

Table 92. Restore history fields

Field Description

Name Name of the restore file.

Completion Date Date and time that the restore process was completed.

Status Status of the restore process. Options include In Progress, Completed, and Failed.

Associated Backup Name of the backup file associated with this restore process.

Schedule backup

You can schedule backups at recurring intervals. The first backup is performed at the specified interval and all subsequent intervals. Scheduled backups are saved with the name - , where is formatted as YYYYMMDDhhmmss.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays.

3. Click the Schedules tab.

4. From the Actions drop-down, select Create New Schedule. The Create Backup Schedule window opens.

5. Enter a schedule name in the Name field.

6. Select a time interval from the Schedule Interval drop-down. Options include Every Hour, Every 3 Hours, Every 6 Hours, and Every 24 Hours.

7. Click Save. The system displays a success message. The saved schedule information displays with the Schedule Name and Schedule Interval.

Edit a backup schedule

You can edit an existing scheduled backup.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays.

3. Click the Schedules tab.

4. Click the check box next to the scheduled backup that you want to edit.

5. From the Actions drop-down, select Edit Schedule. The Edit Backup Schedule window opens.

NOTE: You can only change the Schedule Interval.

6. Select a time interval from the Schedule Interval drop-down.

7. Click Save to apply changes. The system displays a success message. The edited schedule information displays in the schedule list.

Settings 145

Delete a backup schedule

You can delete one or more backup schedules from the Schedule list.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Backup & Restore. The Backup & Restore page displays.

3. Click the Schedules tab.

4. Click the check box next to the scheduled backup that you want to delete.

5. From the Actions drop-down, select Delete Schedule. The system displays a message saying that a backup schedule is deleted, but not the backup files that are associated with that schedule.

6. Click Yes to delete a schedule. The system displays a success message, and the specified schedule is removed from the system.

Downloads The Downloads page provides access to the following:

Access an API token

Access an API token that is used for logging in to the API. This applies to both reader and global admin users.

Steps

1. From the left-side menu, click Settings.

2. Click the Downloads link. The Downloads page is displayed with either a Reader Token or Global Admin Token section.

Figure 30. Reader API token

3. You have these options: Click Copy to Clipboard to copy the token information. Click View to review the token information.

146 Settings

Maintenance mode This section describes Bare Metal Orchestrator maintenance mode. Global-level maintenance mode places the Bare Metal Orchestrator software in maintenance mode and displays a yellow Maintenance Mode banner displays on top of the page. Use this function to prevent any system changes (except upgrade operations) during server down time or during a routine maintenance activity.

You can:

Enable or disable server maintenance mode. View whether a server is in maintenance mode.

NOTE: Only Support Admins can access the web portal when Maintenance mode is enabled. If a Global Admin, Operator, or

Global Reader user tries to log in when Maintenance Mode is active, the system displays this error message:

Figure 31. Maintenance mode login error

Enable and disable maintenance mode

Follow these steps to enable maintenance mode.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Maintenance Mode. The Maintenance Mode page displays.

3. Select Turn on Maintenance Mode. The system displays a message asking whether you want to turn on Maintenance Mode.

4. Click Yes to confirm maintenance mode enablement.

Settings 147

Disable maintenance mode

Follow these steps to disable maintenance mode.

Steps

1. Click Settings on the left-side menu.

The Settings page displays.

2. Click Maintenance Mode. The Maintenance Mode page displays.

3. Clear Turn on Maintenance Mode. The system displays a message asking whether you want to turn off Maintenance Mode.

4. Click Yes to confirm maintenance mode disablement.

View maintenance mode status

Follow these steps to view whether Bare Metal Orchestrator is in maintenance mode.

Steps

1. Enable or disable maintenance mode on Bare Metal Orchestrator. See Enable and disable maintenance mode .

2. View the Inventory<

Manualsnet FAQs

If you want to find out how the Bare Metal Orchestrator Dell works, you can view and download the Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide on the Manualsnet website.

Yes, we have the Web User Interface Guide for Dell Bare Metal Orchestrator as well as other Dell manuals. All you need to do is to use our search bar and find the user manual that you are looking for.

The Web User Interface Guide should include all the details that are needed to use a Dell Bare Metal Orchestrator. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide is by checking the Table of Contents at the top of the page where available. This allows you to navigate a manual by jumping to the section you are looking for.

This Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide consists of sections like Table of Contents, to name a few. For easier navigation, use the Table of Contents in the upper left corner.

You can download Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide free of charge simply by clicking the “download” button in the upper right corner of any manuals page. This feature allows you to download any manual in a couple of seconds and is generally in PDF format. You can also save a manual for later by adding it to your saved documents in the user profile.

To be able to print Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell Bare Metal Orchestrator 1.4 Software Web User Interface Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.