Contents

Dell Bare Metal Orchestrator 1.3 Software Command Line Interface Reference Guide PDF

1 of 155
1 of 155

Summary of Content for Dell Bare Metal Orchestrator 1.3 Software Command Line Interface Reference Guide PDF

Bare Metal Orchestrator 1.3 Command Line Interface Reference Guide

Version 1.3

Abstract

This guide describes how you can use the command line interface to perform different operations on the managed objects in Bare Metal Orchestrator.

Dell Technologies Solutions

September 2022 Rev. 05

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.........................................................................................................................................................................9

Contacting Dell Support.....................................................................................................................................................9

Chapter 1: Introduction................................................................................................................10 Bare Metal Orchestrator Command Line Interface introduction........................................................................... 10 Logging in to the command line interface.................................................................................................................... 11 Control command output using pagination...................................................................................................................11 Using the CLI as a remote client.................................................................................................................................... 12

Chapter 2: users and roles........................................................................................................... 14 Users and roles overview................................................................................................................................................. 14 create user...........................................................................................................................................................................15 get users.............................................................................................................................................................................. 15 edit user................................................................................................................................................................................16 delete user........................................................................................................................................................................... 16 get roles................................................................................................................................................................................16 describe roles...................................................................................................................................................................... 17

Chapter 3: tenant........................................................................................................................ 18 create tenant.......................................................................................................................................................................18 get tenant............................................................................................................................................................................ 18

Tenants operation status........................................................................................................................................... 19 describe tenant...................................................................................................................................................................19 edit tenant...........................................................................................................................................................................20 delete tenant...................................................................................................................................................................... 20

Chapter 4: server.........................................................................................................................21 create server....................................................................................................................................................................... 21 get server.............................................................................................................................................................................21 describe server...................................................................................................................................................................22 edit server........................................................................................................................................................................... 22 delete server.......................................................................................................................................................................22 edit default iDRAC credentials....................................................................................................................................... 23

Chapter 5: servertelemetry......................................................................................................... 24 create servertelemetry.................................................................................................................................................... 24 get servertelemetry.......................................................................................................................................................... 24 describe servertelemetry.................................................................................................................................................25 edit servertelemetry......................................................................................................................................................... 25 delete servertelemetry.....................................................................................................................................................25

Chapter 6: switch........................................................................................................................26 create switch......................................................................................................................................................................26

Contents

Contents 3

get switch........................................................................................................................................................................... 26 describe switch.................................................................................................................................................................. 27 edit switch...........................................................................................................................................................................27 delete switch...................................................................................................................................................................... 27

Chapter 7: web server................................................................................................................. 28 web server.......................................................................................................................................................................... 28 get fs.................................................................................................................................................................................... 28 upload fs.............................................................................................................................................................................. 29 download fs........................................................................................................................................................................ 29 delete fs...............................................................................................................................................................................29

Chapter 8: hardwareprofile......................................................................................................... 30 create hardwareprofile.....................................................................................................................................................30

apply and preview hardware profile status........................................................................................................... 30 get hardwareprofile...........................................................................................................................................................32 describe hardware profile................................................................................................................................................32 edit hardware profile........................................................................................................................................................ 32 delete hardware profile.................................................................................................................................................... 33

Chapter 9: profiletelemetry......................................................................................................... 34 create profiletelemetry.................................................................................................................................................... 34 get profiletelemetry.......................................................................................................................................................... 34 describe profiletelemetry.................................................................................................................................................35 edit profiletelemetry......................................................................................................................................................... 35 delete profiletelemetry.....................................................................................................................................................35

Chapter 10: ipscan.......................................................................................................................36 create ipscan...................................................................................................................................................................... 36 get ipscan............................................................................................................................................................................ 37 delete ipscan.......................................................................................................................................................................37

Chapter 11: media........................................................................................................................ 39 create media.......................................................................................................................................................................39 get media.............................................................................................................................................................................39 describe media................................................................................................................................................................... 40 edit media............................................................................................................................................................................40 delete media....................................................................................................................................................................... 40

Chapter 12: firmwaremedia.......................................................................................................... 41 create firmwaremedia....................................................................................................................................................... 41 get firmwaremedia.............................................................................................................................................................41 describe firmwaremedia...................................................................................................................................................42 edit firmwaremedia........................................................................................................................................................... 42 delete firmwaremedia.......................................................................................................................................................42

Chapter 13: licensemedia.............................................................................................................43 create licensemedia.......................................................................................................................................................... 43 get licensemedia................................................................................................................................................................ 43

4 Contents

describe licensemedia.......................................................................................................................................................44 edit licensemedia............................................................................................................................................................... 44 delete licensemedia...........................................................................................................................................................44

Chapter 14: sites......................................................................................................................... 45 create site........................................................................................................................................................................... 45 get site................................................................................................................................................................................. 45

Site health status........................................................................................................................................................ 46 Site deployment states ............................................................................................................................................. 46 Site operation status...................................................................................................................................................47

describe site........................................................................................................................................................................47 edit site................................................................................................................................................................................ 47 delete site............................................................................................................................................................................ 47

Chapter 15: nodes....................................................................................................................... 48 get node...............................................................................................................................................................................48

Chapter 16: stack........................................................................................................................ 49 create stack........................................................................................................................................................................49 get stack..............................................................................................................................................................................49

Stack operation status...............................................................................................................................................50 describe stack.................................................................................................................................................................... 50 edit stack............................................................................................................................................................................. 51 reinitialize stack.................................................................................................................................................................. 51 delete stack......................................................................................................................................................................... 51

Chapter 17: backup and restore................................................................................................... 53 backup cluster....................................................................................................................................................................53 get backup.......................................................................................................................................................................... 53 create backup restore......................................................................................................................................................54 create backup schedule...................................................................................................................................................54 delete backup schedule................................................................................................................................................... 54 create backup location.....................................................................................................................................................55 delete backup location..................................................................................................................................................... 55 create backup secret....................................................................................................................................................... 55 delete backup secret........................................................................................................................................................56

Appendix A: YAML schema...........................................................................................................57 YAML objects and common fields................................................................................................................................. 57 Metadata............................................................................................................................................................................. 58 YAML field specifications................................................................................................................................................ 58

Site field definitions.................................................................................................................................................... 58 DHCP fields...................................................................................................................................................................59 Server and hardware profile field definitions.........................................................................................................61 Telemetry field definitions.........................................................................................................................................99 Switch field definitions............................................................................................................................................. 100 Media field definitions...............................................................................................................................................104 Driver media field definitions...................................................................................................................................104 User field definitions................................................................................................................................................. 105

Contents 5

Firmware media field definitions............................................................................................................................ 105 Tenant field definitions............................................................................................................................................. 106 Event field definitions............................................................................................................................................... 106 Stack field definitions................................................................................................................................................107

YAML status fields.......................................................................................................................................................... 109 Stack status fields............................................................................................................................................................110

Appendix B: Tenant profile YAML file sample.............................................................................. 112 Sample tenant YAML file................................................................................................................................................ 112

Appendix C: Switch YAML file sample......................................................................................... 113 Sample switch YAML file................................................................................................................................................ 113

Appendix D: Server and hardware profile YAML file samples....................................................... 114 Server and hardware profile YAML file samples....................................................................................................... 114 Sample server YAML file.................................................................................................................................................114 Sample hardware profile YAML file.............................................................................................................................. 116 Sample operating system deployment YAML files - ESXi ......................................................................................117 Sample operating system deployment YAML files - openSUSE ..........................................................................124 Sample operating system deployment YAML files - Red Hat Enterprise Linux................................................ 132 Sample operating system YAML files - Wind River Cloud Platform.................................................................... 137 Sample baseline profile YAML file................................................................................................................................139

Appendix E: Server and profile telemetry YAML file samples.......................................................141 Sample server telemetry YAML file..............................................................................................................................141 Sample profile telemetry YAML file.............................................................................................................................145

Appendix F: Site Configuration YAML Examples......................................................................... 150 Sample DHCP configuration YAML file...................................................................................................................... 150

Appendix G: Stack deployment YAML example........................................................................... 152 Sample VMWare TCP stack deployment YAML file................................................................................................152 Sample TKG deployment YAML file............................................................................................................................ 153 Sample Wind River Cloud Platform stack deployment YAML file........................................................................155

6 Contents

Preface

Purpose This guide describes how you can use the command line interface to comprehensively manage the infrastructure life cycle.

Audience This guide is primarily intended for administrators who are responsible for managing the entire life cycle of the hardware infrastructure in their data centers by using Bare Metal Orchestrator.

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 7

Revision history

This revision history lists major changes to this document.

Table 1. Revisions

Date Release Description

September 2022 1.3 Additional BIOS and BMC attributes, and NIC settings added Additional firmware media categories added S150 Raid Controller enhancements added PXE OS deployment on RHEL supported for Supermicro Servertelemetry and profiletelemetry commands added. YAML file samples and definitions

in the Appendices. Existing functions that are supported through global MinIO S3 have been updated to the

web server and relevant S3 commands have been removed. Driver media field definitions added

June 2022 1.2 The ipscan feature for auto-discovery and onboarding of devices on a particular subnet for a site has been added.

Additional BIOS attributes added with support for HPE and Supermicro PXE Boot support for OS installation added S150 Raid Controller support for virtual volumes added Switch and license media commands added Web server commands added Minor changes across the guide, including updated YAML file samples and field definitions

in the Appendices

March 2022 1.1 BMC updates to reset password and update users PXE boot support with NIC selection and stack setup added Managing S3 storage commands added iDRAC credentials for automatic server discovery added ESXi hostname configuration and fetching the IP address BOSS card support Server deletion Minor changes across the guide, including updated YAML file samples and field definitions

in the Appendices

November 2021 1.0 Inaugural release

8 Revision history

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.

Product support 9

Introduction

Topics:

Bare Metal Orchestrator Command Line Interface introduction Logging in to the command line interface Control command output using pagination Using the CLI as a remote client

Bare Metal Orchestrator Command Line Interface introduction You can rapidly provision, manage, and monitor your Bare Metal Orchestrator infrastructure using the Command Line Interface (CLI).

The CLI is a text-driven interface that manages and monitors the Bare Metal Orchestrator infrastructure and system components. You can use an SSH Ethernet connection or Serial Over LAN (SOL) connection to access the system.

Using CLI commands, you can create, get, edit, delete, and describe Bare Metal Orchestrator objects and configure their attributes.

The following Bare Metal Orchestrator objects are supported:

server hardwareprofile media firmwaremedia user role site node tenant webserver stack ipscan profiletelemetry switch backup backup restore backup schedule backup location secret

Account requirements

If you are using the CLI to configure Bare Metal Orchestrator for the first time, you need a user account before proceeding. Contact your Bare Metal Orchestrator administrator for account information. If you have a Bare Metal Orchestrator user account and are ready to get started, see Logging in to the command line interface. To create a user account, see Users and roles overview.

1

10 Introduction

NOTE: When you use SSH to access Bare Metal Orchestrator as the Dell user for an initial OVA installation, you can run CLI

commands using the default administrator user account. Create a Global Admin user account and use that instead of the

default account to set up Bare Metal Orchestrator using the CLI.

Logging in to the command line interface

Prerequisites

To log in to the Bare Metal Orchestrator CLI on the same VM where Bare Metal Orchestrator is installed, use the default dell user account and password.

If you are using the Bare Metal Orchestrator CLI as a remote client, create a Global Admin user account and use those credentials for authentication. For more information, see Using the CLI as a remote client.

Dell Technologies recommends that you create a Global Admin user account to set up Bare Metal Orchestrator. Use the Global Admin account instead of the default dell user account to perform the set up. For more information about creating user accounts, see the Bare Metal Orchestrator Command Line Interface User's Guide.

About this task

For a day 0 Bare Metal Orchestrator installation, see the Bare Metal Orchestrator Installation Guide.

Steps

1. Open your SSH client and enter the IP address or the hostname of the Bare Metal Orchestrator virtual machine (VM). For high availability configurations, establish a CLI session on the Load Balancer for the Bare Metal Orchestrator cluster.

2. When prompted, enter the default Global Admin username dell and the password. The default password is Dell1234.

NOTE: We recommend that you change the default dell user account password using the $ passwd Linux

command as soon as possible and record the new password for future reference. Contact your Bare Metal Orchestrator

administrator for account information.

Control command output using pagination The CLI provides an option to paginate the displayed output. With pagination, you can control the number of items that are displayed in the output for all objects.

To enable pagination, use the argument --limit in the get command for the required object. This option allows you to retrieve only the number of items that you specify.

Argument definition

limit_value The number of items to be retrieved in the output. If the value is less than or equal to zero, all items are retrieved. The default value is 10.

Example

If you have on-boarded four servers to Bare Metal Orchestrator and want to retrieve the first two servers, run the following command:

bmo get server --limit 2 The CLI returns the first two servers in the output.

Press enter to retrieve the next set of server objects.

Introduction 11

Example Output

The following is an example output for bmo get server --limit 2.

bmo get server --limit 2 NAME POWER STATUS PROVISIONING STATUS COMMAND EXECUTING SITE LOCATION AGE server1 On Ready gc 117s server2 On Ready gc 81s Press enter to continue. Press q or Q or CTRL + C to exit. NAME POWER STATUS PROVISIONING STATUS COMMAND EXECUTING SITE LOCATION AGE server3 On Ready gc 55s server4 Busy CollectingInventory gc 20s

Using the CLI as a remote client

Prerequisites

The user's configuration YAML file and the Certified Signed Request (CSR) must already be created and you need the directory location of the user configuration file.

The IP address of the Linux machine that will host a local copy of the Bare Metal Orchestrator CLI. For a high availability (HA) deployment, you need the IP address of the load balancer.

About this task

You can use the SCP command to create a copy of the Bare Metal Orchestrator CLI to your local Linux machine. Use this copy to remotely access, view, and configure the cluster. The private key and CSR user config YAML file that was generated when your user account was created, is required to authenticate the remote session.

Steps

1. Open a CLI session on the Bare Metal Orchestrator VM using the default dell user account. For high availability configurations, establish a CLI session on the Load Balancer for the Bare Metal Orchestrator cluster.

2. Run the following command to open the user's config YAML file for editing: cat .yaml For example:

cat ryanconfig.yaml

3. In the user's config YAML file, ensure that the server IP address matches the IP address of the Bare Metal Orchestrator VM. If performing a high availability deployment, enter the IP address of the server that is hosting the Load Balancer.

The following shows a sample snippet of a user's config YAML file.

NOTE: The server IP address appears at the beginning and is highlighted in bold.

apiVersion: v1 clusters: - cluster: certificate-authority-data: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tCk1JSUJlVENDQVIrZ0F3SUJBZ0lCQURBS0JnZ3Foa2VkVoXc3B CRlE0bnYyM1pZSGcxRXBhR3RKeVQ3SU9UCi0tLS0tRU5EIENFUlRJRklDQVRFLS0tLS0K server: https://100.10.1.0:6443 name: metalweaver-cluster contexts: - context: cluster: metalweaver-cluster user: ryan name: metalweaver-cluster current-context: metalweaver-cluster kind: Config preferences: {}

12 Introduction

4. Copy the user's config file to the destination host machine using the scp command and enter the login password when prompted. For example: scp ryanconfig.yaml @ The user config file downloads to the destination host machine. You can move the file to a convenient directory location.

5. Copy the Bare Metal Orchestrator CLI to the destination host machine using the scp command and enter the password when prompted. For example: scp /usr/local/bin/bmo @ The Bare Metal Orchestrator CLI downloads to the destination host machine.

6. Access the Bare Metal Orchestrator with the user config file. Run the following command: export KUBECONFIG=~/ .yaml

7. Enter bmo commands from the prompt. For example, if you copied the CLI to the local bin on the destination machine, run: bmo get site

Introduction 13

users and roles You can assign Role-Based Access Control (RBAC) privileges to Bare Metal Orchestrator users. The Global Admin role assigns read and write privileges to all Bare Metal Orchestrator resources. The Global Reader role allows read-only access. A YAML file containing user profile information is used to generate the private key and CSR config file. The user requires the private key and CSR config file to authenticate when logging into the Bare Metal Orchestrator Web UI, or when using a local copy of the Bare Metal Orchestrator CLI as a remote client.

Topics:

Users and roles overview create user get users edit user delete user get roles describe roles

Users and roles overview Role-Based Access Control (RBAC) securely manages access control by assigning permissions to users, based on their allocated roles in Bare Metal Orchestrator. Each role has clearly defined permissions and determines the user's level of access.

Users

Users can have specific access and privileges allocated to them in Bare Metal Orchestrator depending on their assigned roles.

Roles

The following table describes the available roles in Bare Metal Orchestrator and the assigned permissions for each role.

NOTE: Each user can be assigned a single role or multiple roles, which determine their access and privileges in Bare Metal

Orchestrator.

Table 2. Roles and permissions

Role Permissions

Global Admin Read and write privileges to all Bare Metal Orchestrator resources across all tenants, 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.

Global Reader Read-only access to all Bare Metal Orchestrator resources across all tenants, clusters, pods, servers, sites, hardware profiles, and so on.

Can view all other users.

Cannot create, edit, or delete clusters.

2

14 users and roles

Examples

User profile YAML file used to generate the user config file for a user with the Global Reader role:

name: JohnSmith email: john_smith@dell.com country: USA city: Denver organization: Dell orgUnit: BDC province: Co roles: - global-reader

User profile YAML file used to generate the user config file for a user with the Global Admin role:

name: Kyle email: kyle@dell.com country: USA city: Denver organization: Dell orgUnit: BDC province: Co roles: - global-admin

create user bmo create user --file .yaml > .yaml bmo create user -f .yaml > .yaml Creates a user from the user's profile .yaml file and generates a user config file. The user must authenticate the config file when logging into the Bare Metal Orchestrator Web UI or when using the Bare Metal Orchestrator CLI as a remote client.

For example: bmo create user -f ryan.yaml > ryanconfig.yaml

NOTE: For Supermicro and HPE iLO servers, usernames cannot contain special characters.

If the user has Global Admin privileges, the generated user config file authorizes the user to perform admin-level tasks like creating and deleting servers, sites, and other users.

Each user requires a copy of their generated userconfig.yaml file to authenticate when logging in to the Bare Metal Orchestrator web UI and when using a local copy of the CLI as a remote client. If the user config file is lost, a new config file must be generated and provided to the user.

Argument Definitions

username.yaml The profile .yaml file that you create for the user. For example: ryan.yaml

userconfig.yaml The name of the generated user config .yaml file that is the user's Private Key and CSR for role-based access to the resources. For example: ryanconfig.yaml

get users bmo get users Retrieves detailed information about the users in Bare Metal Orchestrator.

bmo get user Retrieves information about a specific user.

users and roles 15

Argument Definition

username The name of a specific user as defined in the user's profile .yaml file. For example: john-smith.

Example Output

The following is an example output for bmo get users:

NAME ROLES john-smith global-reader jerry global-reader

NOTE: A user can have more than one role assigned to them.

Attribute Definitions

Name The name of the user.

Roles The roles that are assigned to the user.

edit user bmo edit user --file bmo edit user -f Allows you to edit the user information using the user's profile .yaml file.

NOTE: Only the user role can be edited.

delete user bmo delete user Deletes the user with the given name.

bmo delete user --file bmo delete user -f Deletes the user that is specified in the user's profile .yaml file.

get roles bmo get roles Retrieves information about the roles in Bare Metal Orchestrator.

bmo get role Retrieves information about the given role in Bare Metal Orchestrator.

Argument Definition

role-name The name of the role given in the .yaml file. For example: global-admin.

16 users and roles

Example Output

The following is an example output for bmo get roles:

global-admin global-reader

describe roles bmo describe role Retrieves detailed information about the given role in Bare Metal Orchestrator.

users and roles 17

tenant A single instance of Bare Metal Orchestrator that is running on a server can be distributed to serve multiple tenants. A tenant is a defined group of users which operates independently of other tenants that share common access to the Bare Metal Orchestrator software instance. Tenants can have specific privileges, including access to data, configuration privileges, user management, and other tenant-specific functionality. However, a tenant cannot view or edit the resources of another tenant. For details about multi-tenancy, see the Bare Metal Orchestrator Command Line Interface User's Guide.

Topics:

create tenant get tenant describe tenant edit tenant delete tenant

create tenant bmo create tenant --file .yaml bmo create tenant -f .yaml Creates a tenant object from the .yaml file.

Argument Definition

tenant-id.yaml The name of the tenant .yaml file. For example: tenant1.yaml.

For more information about the attributes that are required for creating a tenant, see Tenant field definitions.

get tenant bmo get tenant Retrieves information about the tenant objects in Bare Metal Orchestrator.

bmo get tenant Retrieves information about the given tenant object.

bmo get tenant --file .yaml bmo get tenant -f .yaml Retrieves information about the tenant object using the name from the .yaml file.

Argument Definitions

tenantname The name of the tenant given in the .yaml file. For example: tenant1.

tenant-id.yaml The name of the tenant .yaml file. For example: tenant.yaml.

3

18 tenant

Example Output

The following is an example output for bmo get tenant

NAME STATE SERVER SWITCH OPERATION AGE tenant1 Ready 0 0 45s tenant2 Ready 0 0 20s

Attribute Definitions

Name The name of the tenant.

State The status of the tenant. The following states are supported:

ReadyAfter a successful operation, the tenant goes into the Ready state.

BusyWhen operations are in progress, the tenant goes into the Busy state.

FailedWhen operations fail, even after multiple retries, the tenant goes into the Failed state.

Server The number of servers associated with the tenant.

Switch The number of switches associated with the tenant.

Operation The operations that run while a tenant is being created in Bare Metal Orchestrator. For more information, see Tenants operation status.

Age The length of time since the object was created.

Tenants operation status

The following table describes the operation status of tenants:

Table 3. Tenants operation status

Status Description

OnboardingTenant Indicates that the tenant is being on-boarded.

AddingUser Indicates that a user is being added to the tenant.

TranferringResource Indicates that a resource is being transferred from the pool of unassigned resources to the assigned tenant.

ReleasingResource Indicates that a resource is being transferred from the assigned tenant to the pool of unassigned resources.

RemovingUser Indicates that a user is being removed from the tenant.

DeletingTenant Indicates that the tenant is being deleted.

describe tenant bmo describe tenant Retrieves inventory information about the given tenant object.

bmo describe tenant --file .yaml bmo describe tenant -f .yaml Retrieves inventory information about the tenant object using the name from the .yaml file.

tenant 19

edit tenant bmo edit tenant Edits the given tenant object.

bmo edit tenant --file .yaml bmo edit tenant -f .yaml Edits the tenant object using the tenant .yaml file.

delete tenant bmo delete tenant > Deletes the tenant object with the given name.

bmo delete tenant --file .yaml bmo delete tenant -f .yaml Deletes the tenant object using the name in the .yaml file.

20 tenant

server Server deployment and configuration is performed using YAML files on Bare Metal Orchestrator. The YAML file of an individual server is a template that contains configuration settings for that specific server. To deploy and configure multiple servers, use a hardware profile YAML file. The attributes that you add to a server or hardware profile YAML file trigger specific work flows. These work flows include firmware updates, operating system deployment, reinitialization, health monitoring, and so forth.

Topics:

create server get server describe server edit server delete server edit default iDRAC credentials

create server bmo create server --file .yaml bmo create server -f .yaml Creates a server object from the .yaml file.

Argument Definition

server-id.yaml The name of the server .yaml file. For example: dell-server.yaml.

For more information about the attributes that are required for creating a server, see Server and hardware profile field definitions.

get server bmo get server Retrieves information about unassigned server objects in Bare Metal Orchestrator.

bmo get server Retrieves information about the given server object.

bmo get server -n Retrieves information about the server object associated with the given tenant.

bmo get server --file .yaml bmo get server -f .yaml Retrieves information about the server object using the name from the .yaml file.

Argument Definitions

server-name The name of the server given in the .yaml file. For example: dellserver1.

server-id.yaml The name of the server .yaml file. For example: dell-server.yaml.

4

server 21

Example Output

The following is an example output for bmo get server dellserver1.

NAME POWER STATUS PROVISIONING STATUS COMMAND EXECUTING SITE LOCATION AGE dellserver1 On Busy Collecting Inventory austin 5d11h

Attribute Definitions

Name The name of the server.

Power Status The power status of the server. For more information, see Power field definitions.

Provisioning Status

The provisioning status of the server. For more information, see Server provisioning status.

Command Executing

The commands that run while the server is being provisioned in Bare Metal Orchestrator. For more information, see Server command executing status.

Site Location The physical location of the site where the server is deployed.

Age The length of time since the object was created. Server objects are re-created after a restore operation, and the Age column displays the length of time since the object was re-created.

describe server bmo describe server Retrieves inventory information about the given server object.

bmo describe server -n Retrieves inventory information about the unassigned resource server object that is associated with the given tenant.

bmo describe server --file .yaml bmo describe server -f .yaml Retrieves inventory information about the server object using the name from the .yaml file.

edit server bmo edit server Enables you to edit the unassigned resource server object.

bmo edit server -n Enables you to edit the server object that is associated with the given tenant.

bmo edit server --file .yaml bmo edit server -f .yaml Enables you to edit the server object using the server .yaml file.

delete server bmo delete server > Deletes the unassigned resource server object with the given name.

22 server

bmo delete server > -n Deletes the server object that is associated with the given tenant.

bmo delete server --file .yaml bmo delete server -f .yaml Deletes the server object using the name in the .yaml file.

NOTE: If existing commands are in operation at the time of deleting a server, the server deletion will take place after the

commands are executed.

edit default iDRAC credentials The cred.yaml file contains iDRAC user credentials. Use these credentials to connect and manage servers through Bare Metal Orchestrator. You can edit the file after it is created.

You can edit the cred.yaml contents and apply the changes using the following command:

bmo edit default-credential -f cred.yaml

server 23

servertelemetry Server telemetry enablement and configuration are performed using YAML files on Bare Metal Orchestrator. An individual server telemetry YAML file is a template that contains specific server configuration settings. The attributes that you add to a server telemetry YAML file trigger specific work flows to capture metrics.

Topics:

create servertelemetry get servertelemetry describe servertelemetry edit servertelemetry delete servertelemetry

create servertelemetry bmo create servertelemetry --file .yaml bmo create servertelemetry -f .yaml Creates a server telemetry object from the .yaml file.

Argument Definition

servertelemetry- id.yaml

The name of the servertelemetry .yaml file. For example: dell-servertelemetry.yaml.

For more information about the attributes that are required for creating a server telemetry object, see Telemetry field definitions.

get servertelemetry bmo get servertelemetry Retrieves information about server telemetry objects in Bare Metal Orchestrator.

bmo get servertelemetry Retrieves information about the given server telemetry object.

bmo get servertelemetry --file .yaml bmo get servertelemetry -f .yaml Retrieves information about the server telemetry object using the name from the .yaml file.

Argument Definitions

servertelemetry- name

The name of the server telemetry object given in the .yaml file. For example: dellservertelemetry1.

servertelemetry- id.yaml

The name of the server telemetry .yaml file. For example: dell-servertelemetry.yaml.

5

24 servertelemetry

Example Output

The following is an example output for bmo get servertelemetry dellservertelemetry1

NAME SITE LOCATION AGE dellservertelemetry1 gc 18h

Attribute Definitions

Name The name of the server telemetry object.

Site Location The physical location of the site where the server telemetry object is deployed.

Age The length of time since the server telemetry object was created.

describe servertelemetry bmo describe servertelemetry Retrieves inventory information about the given server telemetry object.

bmo describe servertelemetry --file .yaml bmo describe servertelemetry -f .yaml Retrieves inventory information about the server telemetry object using the name from the .yaml file.

edit servertelemetry bmo edit servertelemetry Enables you to edit the server telemetry object.

bmo edit servertelemetry --file .yaml bmo edit servertelemetry -f .yaml Enables you to edit the server telemetry object using the server telemetry .yaml file.

delete servertelemetry bmo delete servertelemetry Deletes the server telemetry object with the given name.

bmo delete servertelemetry --file .yaml bmo delete servertelemetry -f .yaml Deletes the server telemetry object using the name in the .yaml file.

servertelemetry 25

switch Switch deployment and configuration are performed using YAML files on Bare Metal Orchestrator. The YAML file of an individual switch is a template that contains configuration settings for that specific switch. The attributes that you add to a switch YAML file trigger specific work flows like firmware updates, operating system deployment, and reinitialization.

Topics:

create switch get switch describe switch edit switch delete switch

create switch bmo create switch --file .yaml bmo create switch -f .yaml Creates a switch object from the .yaml file.

Argument Definition

switch-id.yaml The name of the switch.yaml file. For example: bmo_dell_switch_profile.yaml.

For more information about the attributes that are required for creating a switch, see Switch field definitions.

get switch bmo get switch Retrieves information about the switch objects in Bare Metal Orchestrator.

bmo get switch Retrieves information about the given switch object.

bmo get switch --file .yaml bmo get switch -f .yaml Retrieves information about the switch object using the name from the .yaml file.

Argument Definitions

switch-name The name of the switch given in the .yaml file. For example: switch-dell.

switch-id.yaml The name of the switch.yaml file. For example: dell-switch.yaml.

6

26 switch

Example Output

The following is an example output for bmo get switch switch-dell

NAME SWITCH MODE PROVISIONING COMMAND EXECUTING SITE LOCATION AGE switch-dell onie Ready gc 8s

Attribute Definitions

Name The name of the switch object.

Switch Mode The mode in which the switch object is created. It can be ONIE or NOS mode for Dell switches and NSO mode for Cisco switches.

Provisioning Status

The status of the switch object. The statuses, Ready, Busy, and Failed are supported. For more information about the status, see Server provisioning status.

Command Executing

The commands that run while the switch object is being provisioned in Bare Metal Orchestrator. For more information, see Switch command executing status.

Site Location The location of the switch object. It can be the global controller or a remote site.

Age The length of time since the switch object was created.

describe switch bmo describe switch Retrieves detailed information about the given switch.

bmo describe switch --file .yaml bmo describe switch -f .yaml Retrieves detailed information about the switch using the name from the .yaml file.

edit switch bmo edit switch Enables you to edit the given switch object.

bmo edit switch --file .yaml bmo edit switch -f .yaml Enables you to edit the switch object using the .yaml file.

delete switch bmo delete switch Deletes the switch object with the given name.

bmo delete switch --file .yaml bmo delete switch -f .yaml Deletes the switch object using the name in the .yaml file.

switch 27

web server

Topics:

web server get fs upload fs download fs delete fs

web server A web server is required to host files and images that are used for various Bare Metal Orchestrator operations such as PXE and TCP stack deployment. The web server can perform basic POST/GET/DELETE commands. The maximum time limit for a CLI operation is set to 45 minutes. The maximum file size that you can upload into the web server is 20 GB. The maximum storage limit for all files within the web server is 50 GB.

get fs bmo get fs Retrieves information about the files that are transferred to the default storage path in the web server.

bmo get fs -m Retrieves information about a file from a specific folder in the web server.

Argument Definitions

folder name The name of a folder in the web server. For example: Images.

Example Output

The following is an example output for bmo get fs.

NAME TYPE LAST MODIFIED user1 directory Wed, 02 Feb 2022 11:58:00 GMT file1 file Wed, 02 Feb 2022 11:59:40 GMT

Attribute Definitions

Name The name of the file.

Type The type of object, which can be a file or directory.

Last Modified The date that the file was last modified.

7

28 web server

upload fs bmo upload fs --file bmo upload fs -f Enables you to upload a specific file to the web server.

bmo upload fs -f -m Enables you to upload a file to a specific folder in the web server. Using this command, you can either upload to an existing folder or create a new folder with the name you provide in the folder name value.

Argument Definitions

file of upload object

The name of the file to upload to the web server. For example: cred.yaml.

folder name The name of a folder in the web server. For example: Images.

download fs bmo download fs -f bmo download fs --file Enables you to download a specific file from the web server.

bmo download fs -f -m Enables you to download a file from a specific folder in the web server.

Argument definitions

file of download object

The name of the file to download from the web server.

delete fs bmo delete fs --file bmo delete fs -f Enables you to delete a file in the web server.

bmo delete fs -f -m Enables you to delete a file from a specific folder in the web server.

Argument definitions

file of delete object

The name of the file to delete from the web server.

web server 29

hardwareprofile Hardware profiles are server configuration templates that enable bulk provisioning and simplify repetitive administrative tasks. Use them to apply settings to multiple servers in the Bare Metal Orchestrator cluster for consistent and reproducible setups. A preview attribute lets you view the status of the servers that the hardware profile targets before you apply the configuration. The hardware profile does not update the configuration of targeted servers that are in a non-ready state.

For more information on applying a hardware profile and previewing the server status, see apply and preview hardware profile status.

Topics:

create hardwareprofile get hardwareprofile describe hardware profile edit hardware profile delete hardware profile

create hardwareprofile bmo create hardwareprofile --file .yaml bmo create hardwareprofile -f .yaml Creates a hardware profile object from the .yaml file.

Argument Definition

hardwareprofile- id.yaml

The name of the hardware profile .yaml file. For example: bmo_dell_hwprofile.yaml.

For more information about the attributes that are required for creating a hardware profile, see Server and hardware profile field definitions.

To apply a hardware profile and preview server status, see apply and preview hardware profile status.

apply and preview hardware profile status

The following table lists the apply and preview attributes that you can add to a hardware profile. For more hardware profile attribute descriptions, see Server and hardware profile field definitions.

Table 4. apply and preview attributes

Attribute Description Values

apply Include the apply attribute in the spec section of the hardware profile and set to true to apply the hardware profile to the targeted servers when the bmo edit hardwareprofile -f .yaml command is run.

Only servers that are specifically targeted in the hardware profile are configured. For more information about targeting servers, see the Bare Metal Orchestrator Command Line Interface User's Guide.

true or false

preview Include the preview attribute in the spec section of the hardware profile and set to true to collect status information for the servers that the hardware profile targets.

true or false

8

30 hardwareprofile

Table 4. apply and preview attributes (continued)

Attribute Description Values

To populate the status section, save and quit the hardware profile. Then, run the bmo describe hardwareprofile -f .yaml command. Targeted servers that are in a non-ready state are shown under failedList.

The hardware profile configuration is only applied to the targeted servers when the apply attribute is set to true.

NOTE: You cannot set both the apply and preview attributes to true at the

same time in the hardware profile.

Example apply and preview attributes in a hardware profile

The following is an example of the apply and preview attributes in the spec section of a hardware profile.

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: name: hw-profile001 labels: site: gc spec: preview: true apply: false ## the hardware profile is applied only to servers listed below serverList: - name: server22 namespace: metalweaver - name: server21 namespace: metalweaver ## Add more fields below server: powerState: "Off"

Example preview output

The following is an example of the status section that appears in a hardware profile targeting two servers where one of two servers is in the failedList.

"status": { "serverStatus": { "hash": "14567238376801881703", "preview": { "summary": "hardware profile can be applied on (1) servers at time [2022-03-11T07:56:10Z]", "failedList": { "metalweaver": [ "server126" ] } }, "apply": {} "switchStatus": { "preview": {} }, "hash": "13067907972745477115"

hardwareprofile 31

get hardwareprofile bmo get hardwareprofile Retrieves information about the hardware profiles in Bare Metal Orchestrator.

bmo get hardwareprofile Retrieves information about the given hardware profile.

bmo get hardwareprofile --file .yaml bmo get hardwareprofile -f .yaml Retrieves information about the hardware profile using the name from the .yaml file.

Argument Definitions

hardwareprofile- name

The name of the hardware profile given in the .yaml file. For example: hardwareprofile-dell.

hardwareprofile- id.yaml

The name of the hardware profile .yaml file. For example: bmo_dell_hwprofile.yaml.

Example Output

The following is an example output for bmo get hardwareprofile hardwareprofile-dell

NAME AGE hardwareprofile-dell 15m

Attribute Definitions

Name The name of the hardware profile.

Age The length of time since the object was created.

describe hardware profile bmo describe hardwareprofile Retrieves detailed information about the given hardware profile.

bmo describe hardwareprofile --file .yaml bmo describe hardwareprofile -f .yaml Retrieves detailed information about the hardware profile using the name from the .yaml file. If the preview attribute is included and set to true in the hardware profile, the status of all targeted servers is collected.

edit hardware profile bmo edit hardwareprofile Enables you to edit the given hardware profile.

bmo edit hardwareprofile --file .yaml bmo edit hardwareprofile -f .yaml

32 hardwareprofile

Enables you to edit the hardware profile using the .yaml file.

delete hardware profile bmo delete hardwareprofile Deletes the hardware profile object with the given name.

bmo delete hardwareprofile --file .yaml bmo delete hardwareprofile -f .yaml Deletes the hardware profile object using the name in the .yaml file.

hardwareprofile 33

profiletelemetry Profile telemetry enablement and configuration are performed using YAML files on Bare Metal Orchestrator. To enable telemetry and configure metrics on multiple servers, use a profile telemetry YAML file. The attributes that you add to a profile telemetry YAML file trigger specific work flows to capture metrics.

Topics:

create profiletelemetry get profiletelemetry describe profiletelemetry edit profiletelemetry delete profiletelemetry

create profiletelemetry bmo create profiletelemetry --file .yaml bmo create profiletelemetry -f .yaml Creates a profile telemetry object from the .yaml file.

Argument Definition

profiletelemetry- id.yaml

The name of the profile telemetry .yaml file. For example: bmo_dell_profiletelemetry.yaml.

For more information about the attributes required for creating a profile telemetry object, see Telemetry field definitions.

To apply a hardware profile and preview server status, see apply and preview hardware profile status.

get profiletelemetry bmo get profiletelemetry Retrieves information about the profile telemetry objects in Bare Metal Orchestrator.

bmo get profiletelemetry Retrieves information about the given profile telemetry object.

bmo get profiletelemetry --file .yaml bmo get profiletelemetry -f .yaml Retrieves information about the profile telemetry object using the name from the .yaml file.

Argument Definitions

profiletelemetry- name

The name of the profile telemetry object given in the .yaml file. For example: profiletelemetry- dell.

profiletelemetry- id.yaml

The name of the profile telemetry .yaml file. For example: bmo_dell_profiletelemetry.yaml.

9

34 profiletelemetry

Example Output

The following is an example output for bmo get profiletelemetry profiletelemetry-dell

NAME AGE profiletelemetry-dell 15m

Attribute Definitions

Name The name of the profile telemetry object.

Age The length of time since the object was created.

describe profiletelemetry bmo describe profiletelemetry Retrieves detailed information about the given profile telemetry object.

bmo describe profiletelemetry --file .yaml bmo describe profiletelemetry -f .yaml Retrieves detailed information about the profile telemetry object using the name from the .yaml file. If the preview attribute is included and set to true in the hardware profile, the status of all targeted servers is collected.

edit profiletelemetry bmo edit profiletelemetry Enables you to edit the given profile telemetry object.

bmo edit profiletelemetry --file .yaml bmo edit profiletelemetry -f .yaml Enables you to edit the profile telemetry object using the .yaml file.

delete profiletelemetry bmo delete profiletelemetry Deletes the profile telemetry object with the given name.

bmo delete profiletelemetry --file .yaml bmo delete profiletelemetry -f .yaml Deletes the profile telemetry object using the name in the .yaml file.

profiletelemetry 35

ipscan You can use ipscan to auto-discover managed devices such as servers that are connected to a particular subnet but are not yet onboarded with Bare Metal Orchestrator. Secure ports are scanned and any available devices that Bare Metal Orchestrator can manage are discovered.

Topics:

create ipscan get ipscan delete ipscan

create ipscan bmo create ipscan -n -f .yaml Request a scan of a particular subnet to auto-discover devices on the network that are eligible for onboarding. Only secure ports are scanned on the subnet. The device's credentials must be added to the Bare Metal Orchestrator cred.yaml file before scanning the network. For instructions to update the cred.yaml file, see the Bare Metal Orchestrator Command Line Interface User's Guide.

Argument Definition

sitelocation The location that was defined for the site. This CLI command uses the location as the site namespace. For more information about the site location, see Site field definitions.

ipconfig.yaml The name of the .yaml file that defines the start and end range of IP addresses to scan, the subnet CIDR, the scan frequency, and specific host IP addresses as applicable. An example ipconfig.yaml file is available in the ~/samples/ipscan/ directory.

Example ipconfig.yaml

The following is an example ipconfig.yaml file.

start_range: 100.10.1.0 end_range: 100.10.1.4 subnet_cidr: 100.10.1.8/31 hosts: - 100.10.1.101 - 100.10.1.102 scan_frequency: 14400 ##entered in seconds

Attribute Definitions

start_range The starting IP address for an IP range. Must be specified coupled with endRange.

end_range The end IP address for an IP range. Must be specified coupled with startRange.

subnet_cidr An IP network specified in a CIDR format.

hosts A user-defined list of specific IP addresses to scan.

10

36 ipscan

scan_frequency Schedule the frequency of IP scans in seconds. Only one IP scan can be active for a site at any one time. The current scan must end before the next scan starts. The minimum scan frequency is once every 300 seconds, and the maximum scan frequency is once every 86,400 seconds.

get ipscan bmo get ipscan -n Display the IP scan settings for a site and list the IP addresses for any devices on the network that were discovered during the last scan.

Argument Definition

sitelocation The location that was defined for the site. This CLI command uses the location as the site namespace. For more information about the site location, see Site field definitions.

Example output

The following is an example output for bmo get ipscan -n , where the IP scan settings are empty and there are no auto-discovered IP addresses to display.

ip_list: [] last_conf: []

The following is an example output for a populated list of auto-discovered IP addresses from the last time the ipscan was run, and the current IP scan settings.

ip_list: 100.10.1.2 100.10.1.9 100.10.1.101 100.10.1.102

last_conf start_range: 100.10.1.0 end_range: 100.10.1.4 subnet_cidr: 100.10.1.8/31 hosts: - 100.10.1.101 - 100.10.1.102 scan_frequency: 14400 ##entered in seconds

NOTE: To see a list of onboarded devices, you can run bmo get , where is the type of device,

such as server or switch.

delete ipscan bmo delete ipscan -n Deletes the ipconfig scan settings for a site. The IP address start and end ranges and the subnet CIDR value are reset. Plus any specified host IP addresses are removed. The site's scan_frequency value is also reset to 0, which stops auto-discovery scanning for devices at the site.

ipscan 37

Argument Definition

sitelocation The location that was defined for the site. This CLI command uses the location as the site namespace. For more information about the site location, see Site field definitions.

38 ipscan

media When installing an operating system on a server in the Bare Metal Orchestrator cluster, you must create a media object to represent the operating system ISO that was saved to the web server. A YAML file is used to create the media object and defines attributes such as the ISO file name, managed device type, os version, and other related attributes.

Topics:

create media get media describe media edit media delete media

create media bmo create media --file .yaml bmo create media -f .yaml Creates a media object from the .yaml file.

Argument Definition

media-id.yaml The name of the media .yaml file. For example: bmo_esxi_media.yaml.

For more information about the attributes that are required for creating a media object, see Media field definitions.

get media bmo get media Retrieves information about the media objects in Bare Metal Orchestrator.

bmo get media Retrieves information about the given media object.

bmo get media --file .yaml bmo get media -f .yaml Retrieves information about the media object using the name from the .yaml file.

Argument Definitions

media-name The name of the media object given in the .yaml file. For example: esxi-iso.

media-id.yaml The name of the media .yaml file. For example: bmo_esxi_media.yaml.

11

media 39

Example Output

The following is an example output for bmo get media esxi-iso

NAME AGE esxi-iso 8d14h

Attribute Definitions

Name The name of the media object.

Age The length of time since the object was created.

describe media bmo describe media Retrieves detailed information about the given media.

bmo describe media --file .yaml bmo describe media -f .yaml Retrieves detailed information about the media using the name from the .yaml file.

edit media bmo edit media Enables you to edit the given media object.

bmo edit media --file .yaml bmo edit media -f .yaml Enables you to edit the media object using the .yaml file.

delete media bmo delete media Deletes the media object with the given name.

bmo delete media --file .yaml bmo delete media -f .yaml Deletes the media object using the name in the .yaml file.

40 media

firmwaremedia When installing a firmware update on a server, you must create a firmware media object for each type of firmware update. For example, if you are updating firmware for both BIOS and diagnostics, you must create two different media objects.

Topics:

create firmwaremedia get firmwaremedia describe firmwaremedia edit firmwaremedia delete firmwaremedia

create firmwaremedia bmo create firmwaremedia --file .yaml bmo create firmwaremedia -f .yaml Creates a firmware media object from the .yaml file.

Argument Definition

firmwaremedia- id.yaml

The name of the firmware media .yaml file. For example: firmwaremedia.yaml.

For more information about the attributes that are required for creating a firmware media, see Firmware media field definitions.

get firmwaremedia bmo get firmwaremedia Retrieves information about the firmware media objects in Bare Metal Orchestrator.

bmo get firmwaremedia Retrieves information about the given firmware media object.

bmo get firmwaremedia --file .yaml bmo get firmwaremedia -f .yaml Retrieves information about the firmware media object using the name from the .yaml file.

Argument Definitions

firmwaremedia- name

The name of the firmware media object given in the .yaml file. For example: firmware-full.

firmwaremedia- id.yaml

The name of the media .yaml file. For example: firmwaremedia.yaml.

12

firmwaremedia 41

Example Output

The following is an example output for bmo get firmwaremedia firmware-full

NAME AGE firmware-full 8d14h

Attribute Definitions

Name The name of the firmware media object.

Age The length of time since the object was created.

describe firmwaremedia bmo describe firmwaremedia Retrieves detailed information about the given firmware media.

bmo describe firmwaremedia --file .yaml bmo describe firmwaremedia -f .yaml Retrieves detailed information about the firmware media using the name from the .yaml file.

edit firmwaremedia bmo edit firmwaremedia Enables you to edit the given firmware media object.

bmo edit firmwaremedia --file .yaml bmo edit firmwaremedia -f .yaml Enables you to edit the firmware media object using the .yaml file.

delete firmwaremedia bmo delete firmwaremedia Deletes the firmware media object with the given name.

bmo delete firmwaremedia --file .yaml bmo delete firmwaremedia -f .yaml Deletes the firmware media object using the name in the .yaml file.

42 firmwaremedia

licensemedia You must create a license media object when installing a Dell OS10 license on a switch in Bare Metal Orchestrator. This object represents the license file that was uploaded to the web server.

Topics:

create licensemedia get licensemedia describe licensemedia edit licensemedia delete licensemedia

create licensemedia bmo create licensemedia --file .yaml bmo create licensemedia -f .yaml Creates a license media object from the .yaml file.

Argument Definition

licensemedia- id.yaml

The name of the licensemedia .yaml file. For example: bmo_os10_media.yaml.

get licensemedia bmo get licensemedia Retrieves information about the license media objects in Bare Metal Orchestrator.

bmo get licensemedia Retrieves information about the given license media object.

bmo get licensemedia --file .yaml bmo get licensemedia -f .yaml Retrieves information about the license media object using the name from the .yaml file.

Argument Definitions

licensemedia- name

The name of the license media object given in the .yaml file. For example: license12

licensemedia- id.yaml

The name of the license media .yaml file. For example: bmo_license_media.yaml.

13

licensemedia 43

Example Output

The following is an example output for bmo get licensemedia license12

NAME AGE license12 8d14h

Attribute Definitions

Name The name of the license media object.

Age The length of time since the object was created.

describe licensemedia bmo describe licensemedia Retrieves detailed information about the given license media.

bmo describe licensemedia --file .yaml bmo describe licensemedia -f .yaml Retrieves detailed information about the license media using the name from the .yaml file.

edit licensemedia bmo edit licensemedia Enables you to edit the given license media object.

bmo edit licensemedia --file .yaml bmo edit licensemedia -f .yaml Enables you to edit the license media object using the .yaml file.

delete licensemedia bmo delete licensemedia Deletes the license media object with the given name.

bmo delete licensemedia --file .yaml bmo delete licensemedia -f .yaml Deletes the license media object using the name in the .yaml file.

44 licensemedia

sites A site is a physical location where servers are deployed. Bare Metal Orchestrator uses two types of sites; a Global Controller site, and a remote site. A Global Controller site is the default site that is created when Bare Metal Orchestrator is deployed and constitutes core components and site components. You can manually create remote sites in different locations and each remote site can manage servers that are associated with it.

Topics:

create site get site describe site edit site delete site

create site bmo create site --file .yaml bmo create site -f .yaml Creates a site object from the .yaml file.

Argument Definition

site-id.yaml The name of the site .yaml file. For example: global_site.yaml.

For more information about the attributes that are required for creating a site, see Site field definitions.

get site bmo get site Retrieves information about the site objects in Bare Metal Orchestrator.

bmo get site Retrieves information about the given site object.

bmo get site --file .yaml bmo get site -f .yaml Retrieves information about the site object using the name from the .yaml file.

Argument Definition

sitename The name of the site given in the .yaml file. For example: gc for the Global Controller site or a user-defined site name.

site-id The name of the site .yaml file. For example: site1.yaml.

14

sites 45

Example Output

The following is an example output for bmo get site gc

NAME NODE NAME LOCATION HEALTH STATE OPERATION AGE gc bmo-manager-1 gc OK Busy DeployingModule 2h

Attribute Definitions

Name The name that is assigned to the site can include up to 253 characters. The default site name for the Global Controller is gc.

Node name The name of the node where the site is deployed. The default node name for the Global Controller is bmo-manager-1.

Location The location of the site that can include up to 15 characters.

For more information about the site name and location, see Site field definitions.

Health The health status of the site. For more information, see Site health status.

State The deployment state of the site. For more information, see Site deployment states

Operation The status of operations in a site. For more information, see Site operation status.

Age The length of time since the object was created.

Site health status

The following table describes the health status of sites:

Table 5. Site health status

Status Description

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

Warn Indicates that the site is in a state that requires corrective action.

Critical Indicates that critical problems exist with site deployment. These issues must be fixed immediately. For example: If the deployment of a component in a site fails, the health status changes to Critical.

Site deployment states

The following table describes the deployment states of sites:

Table 6. Site deployment states

Status Description

Ready After a successful site operation, the site goes into the Ready state. It also indicates that Bare Metal Orchestrator is ready to run the next operation. For example: If AddingTaint is complete, the next operation DeployingModule starts.

The state changes back to Busy when the operation is in progress.

Busy Indicates that operations are being performed on the site.

Failed Indicates a failure in the site operation even after maximum retries. Failures can happen in several scenarios.

For example: Deployment of a component in the site may fail.

46 sites

Table 6. Site deployment states (continued)

Status Description

During retry, the state changes to Busy. However, the operation starts only after a reconciliation trigger.

Site operation status

The following table describes the operation status of the sites:

Table 7. Site operation status

Status Description

AddingTaint The location applied to the node based on the location defined during the creation of a site.

DeployingModule Indicates that the components of the site are being deployed.

DeletingModule Indicates that the components of the site are being deleted.

HealthCheck Indicates that the health checks are being performed on the site.

UpdatingModule Indicates that the components of the site are being updated.

describe site bmo describe site Retrieves detailed information about the given site object.

bmo describe site --file .yaml bmo describe site -f .yaml Retrieves detailed information about the site object using the name from the .yaml file.

edit site bmo edit site Enables you to edit the given site object.

bmo edit site --file .yaml bmo edit site -f .yaml Enables you to edit the site object using the .yaml file.

For more information about the attributes that are required for editing a site, see Site field definitions.

delete site bmo delete site Deletes the site object with the given name.

NOTE: You cannot delete a GC site.

bmo delete site --file .yaml bmo delete site -f .yaml Deletes the site object using the name in the .yaml file.

sites 47

nodes Nodes are the points of communication between a server and a site. You can create Worker nodes for a server and associate the node with a site. The node transfers server metadata to the site, which can then be viewed and updated as required in Bare Metal Orchestrator.

Topics:

get node

get node bmo get node Retrieves information about the nodes in Bare Metal Orchestrator.

Example Output

The following is an example output for bmo get node

NAME ON-BOARDED SITE AGE INTERNAL-IP bmo-manager-1 gc 13d 111.11.0.11 worker1 sclara 13d 100.10.0.10

For more information about the attributes, see Node field definitions.

15

48 nodes

stack The deployment of stacks reduces operational complexity and improves the agility of telecommunication networks and infrastructure. Bare Metal Orchestrator supports the deployment of several stacks, including: VMware Telco Platform (TCP) 2.0, VMware Tanzu Kubernetes Grid (TKG), and Wind River Cloud Platform.

Topics:

create stack get stack describe stack edit stack reinitialize stack delete stack

create stack bmo create stack --file bmo create stack -f Creates a stack resource from a .yaml file.

Argument Definition

stack.yaml The name of the stack .yaml file. For example: wrcp_stack.yaml.

get stack bmo get stack(s) Retrieves all stack resources in Bare Metal Orchestrator.

bmo get stack Retrieves stack resource with the given name.

bmo get stack --file bmo get stack -f Retrieves stack resource using the name from the .yaml file.

Argument Definitions

stack-name The name of the stack given in the .yaml file. For example: mystack.

mystack.yaml The name of the stack .yaml file. For example: wrcp_stack.yaml.

16

stack 49

Example Output

The following is an example output for bmo get stack

NAME PROVISIONING STATUS OPERATION EXECUTING SITE LOCATION AGE tcp-stack Ready gc 15d

Attribute Definitions

Name The name of the stack object.

Provisioning status

The status of the stack object. The following states are supported:

Ready- After a successful operation, the stack object goes into the Ready state.

Busy- When operations are in progress, the stack object goes into the Busy state.

Failed- When operations fail, even after multiple retries, the stack object goes into the Failed state.

Deleting- The stack object is being deleted.

Operation executing

The operations that run while a stack object is being created. For more information, see Stack operation status.

Site Location The location of the stack object. It can be the global controller or a remote site.

Age The length of time since the object was created.

Stack operation status

The following table describes the operation status of stack objects:

Table 8. Stack operation status

Status Description

DeployStack Indicates that the stack is being deployed.

DeploymentProgress Indicates the stack deployment progress.

Resync Indicates resynchronizing stack deployment.

Grow Indicates that a user can grow the stack domain with a host or with a new cell site domain.

ValidateImport Indicates validation of stack import.

Import Indicates stack import.

DeployTKGTemplate Indicates TKG template deployment.

DeployTKGCluster Indicates TKG cluster deployment.

DeleteTKGTemplate Indicates TKG template deletion.

DeleteTKGCluster Indicates TKG cluster deletion.

describe stack bmo describe stack Retrieves inventory information about the given stack object.

bmo describe stack --file

50 stack

bmo describe stack -f Retrieves inventory information about the stack object using the name from the .yaml file.

Argument Definition

stack.yaml The name of the stack .yaml file. For example: wrcp_stack.yaml.

stack-name The name of the stack given in the .yaml file. For example: mystack.

edit stack bmo edit stack Enables you to edit the given stack object. For example to add a cell site by onboarding ESXi-enabled servers:

bmo edit stack bmo edit stack --file bmo edit stack -f

NOTE: The edit stack command is not supported for Wind River Cloud Platform cloud deployments.

Argument Definition

grow.yaml The name of the .yaml file that contains the additional cell site information. For example: wrcp_stack.yaml.

stack-name The name of the stack given in the .yaml file. For example: mystack.

reinitialize stack bmo reinitialize stack Sends a resync request to the stack installer to reinitialize the stack. Before running this command, you must edit the stack resource to add the spec.reInitialize attribute and set the value to true.

NOTE: The reinitialize stack command is not supported for Wind River Cloud Platform cloud deployments.

Argument Definition

stack-name The name of the stack given in the .yaml file. For example: mystack.

delete stack bmo delete stack Deletes the stack object with the given name.

bmo delete stack --file bmo delete stack -f Deletes the stack object using the name in the .yaml file.

stack 51

Argument Definition

stack-name The name of the stack given in the .yaml file. For example: mystack.

52 stack

backup and restore You can schedule or manually take snapshots of the Bare Metal Orchestrator cluster configuration in the ETCD database of the Global Controller node. You can use the snapshots to fully restore the cluster. The backup contains all configuration data, state, and metadata for the cluster. The backup is stored in the MinIO S3 store on the Global Controller in a bucket that is called bmo-backup by default. We recommend 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. Back up files are valid for up to 30 days. For details about backup and restore, see the Bare Metal Orchestrator Command Line Interface User's Guide.

Topics:

backup cluster get backup create backup restore create backup schedule delete backup schedule create backup location delete backup location create backup secret delete backup secret

backup cluster bmo create backup save --name Takes an immediate snapshot of the ETCD database of the Global Controller and saves the backup file to the MinIO S3 storage location.

Argument Definition

backupname The name that you assign to the on-demand backup file. For example: mycluster-backup.

get backup bmo get backup Retrieves information about the backup files in the MinIO S3 storage location.

Example Output

The following is an example output for bmo get backup

NAMESPACE NAME AGE velero backup1 10s

Attribute Definitions

Namespace The velero namespace identifies that the object is related to cluster backups.

17

backup and restore 53

Name The name that is assigned to the backup file when the backup was created.

Age The length of time since the backup file was generated.

create backup restore bmo create backup restore --backup_name Restores the Global Controller and worker nodes, site configurations, users and role information, and related metadata from a backup file.

NOTE:

Do not perform other cluster operations while the cluster is being restored. For example, do not create sites, add worker

nodes, or add users during the restore.

Argument Definition

backupname The name of the backup file that you want to use to restore the cluster.

create backup schedule bmo create backup schedule --name --schedule=" " Creates a backup schedule for the entire cluster, including the Global Controller and worker node configurations, sites, and related metadata.

For example: bmo create backup schedule --name backup1 --schedule="@every 24h"

Argument Definitions

schedulebackupn ame

The name of the backup schedule. This name is also applied to the backup files that are created.

timeinterval The scheduled backup time interval that is set using a cron time string of five characters. Time values are based on UTC.

For example, enter the following time interval to schedule a backup to occur every 15th of the month at 10:00 am:

0.10.15.*.*

where each attribute from left to right defines the following:

minute (values 0 to 59) hour (values 0 to 23) day of the month (values 1 to 31) month (values 1 to 12) day of the week (values 0 to 7, where both 0 and 7 represent Sunday)

Entering an * assigns no specific value.

You can also enter the time interval using the @every syntax and specify a combination of seconds (s), minutes (m), and hours (h). For example: @every 2h30m

delete backup schedule bmo delete backup schedule --name

54 backup and restore

Deletes the backup schedule, which stops the scheduled backups. However, existing backup files remain in the backup location.

Argument Definition

schedulebackupn ame

The name that you assign the backup schedule. For example: backup1.

create backup location bmo create backup location --name --bucket --address --skip-tls Changes the default MinIO S3 storage location where the cluster backup files are saved. Typically, this location is changed to an external S3 storage location. You can use any Velero supported S3 provider as an external backup location. For more information, consult the official Velero website.

Before proceeding you must:

Delete the current MinIO S3 backup storage location, see delete backup location. Delete the backup storage location secret for the current MinIO S3 backup storage location, see delete backup secret. Create a backup storage location secret for the new external S3 backup storage location, see create backup location.

Argument Definitions

backuplocationna me

The name of the location where backup files are saved in the external MinIO S3 store.

bucket name The name of the S3 bucket in the external MinIO S3 store where the cluster backup files are saved.

IPaddress:port The IP address and port of the location of the external S3 store. is an IP address or FQDN value, and the port number is appended to that.

skip-tls Flag to specify the S3 store endpoint over a secure channel.

delete backup location bmo delete backup-location --name Deletes the current MinIO S3 storage location for backups that is defined in Bare Metal Orchestrator. This does not delete the contents of the S3 storage location.

Argument Definition

backuplocationna me

The name of the location where backup files are saved in the external MinIO S3 store.

create backup secret bmo create secret -f .yaml Creates an AWS secret key for the external MinIO S3 storage location using a YAML file.

NOTE: For information about the contents of , see the Bare Metal Orchestrator Command Line

Interface User's Guide

backup and restore 55

Argument Definitions

secretfilename.y aml

The name of the YAML file containing the AWS secret key for the external MinIO S3 store. For more information, see the Bare Metal Orchestrator Command Line Interface User's Guide.

delete backup secret bmo delete secret -n Deletes the secret credentials for the current MinIO S3 storage location where cluster backups are saved.

Argument Definition

secretname The name of the existing MinIO S3 backup storage location secret. For example: mycloud- credentials.

namespace The namespace that is entered should be velero to identify that the object is related to cluster backups.

56 backup and restore

YAML schema

Topics:

YAML objects and common fields Metadata YAML field specifications YAML status fields Stack status fields

YAML objects and common fields You can create, edit, view, or delete objects with the YAML file. The following objects are supported:

server hardwareprofile media firmwaremedia user role site node tenant stack switch backup backup restore backup schedule backup location secret The .yaml file typically contains the following fields:

apiVersion Defines the version of the Kubernetes API that you are using for an object. The apiVersion is set to mw.dell.com/v1. Do not update this field.

kind A string value representing the type of the object. For example: Server. Do not update this field.

metadata Contains information about the object, such as its labels. You can update the metadata. For more information, see Metadata.

spec The specification section that contains configuration details of the objects. Specification differs based on the object created. This is an editable field. For more information about the specifications for different objects, see YAML field specifications.

status An auto-generated field that reports the current state of the system. Do not update this field. For more information about the status, see YAML status fields.

CAUTION: You can provide BMC credentials when creating a server or a hardware profile. The BMC password

that is provided is in a plain-text format, which is less secure. Ensure that you secure the appropriate YAML

files to safeguard your system from malicious attacks.

A

YAML schema 57

Metadata

The .yaml file metadata is described in the following table:

Table 9. YAML File Metadata

Field Description Supported values

name Name that describes the object. For example:

If you are creating a server, you can name it dell-server1.

If you are creating a site, you can name it austin.

If you are creating media, you can name it os-media.

NOTE: If discoveryViaDhcp is set to auto, the prefix auto- is

added to the site name.

The first and last character must be alphanumeric.

The maximum character limit for a server name is 51.

The maximum character limit for a site name is 253.

Alphanumeric (a to z, 0 to 9), dash (-), or period (.)

labels Specifies one or more labels and their values. You can define your own labels. However, the profile label is reserved for internal operations such as server decommissioning.

A site label is mandatory for server, switch, and hardware profiles.

site: Location field of the site. This is a required field.

NOTE: The site label must match the value set for the metadata location in the site object.

Examples of user-defined labels that you can use to identify and target specific servers and switches:

vendor: The name of the hardware manufacturer.

NOTE: Servers and switches that are auto-discovered have vendor labels that are updated automatically.

model: The model of the server or the switch. tenantName: Name of the tenant. Add this label to apply hardware profiles on the servers present under a tenant.

The maximum character limit is 63.

The first and last character must be alphanumeric.

Alphanumeric (a to z, A to Z, 0 to 9), dash (-), underscore (_), period (.), or can be left empty

YAML field specifications The following sections define YAML fields that are used to configure Bare Metal Orchestrator and its environment.

Site field definitions

The following table contains definitions and supported values for the fields in a site.

Table 10. Site Field Definitions

Field Description Example supported values

nodeName The name of the node where the site is deployed.

Must be the name of the Global Controller node or an existing worker node. Worker node names are user configurable.

bmo-manager-1 (Global Controller default)

worker1, worker2, etc.

58 YAML schema

Table 10. Site Field Definitions (continued)

Field Description Example supported values

type The site type. Use global for the Global Controller node. Use remote for remote worker sites that you create.

global or remote

location The site location. The supported characters are alphanumeric (a to z, 0 to 9) and hyphen (-). The maximum character limit is 15. The first and last character must be alphanumeric.

miami, austin, and so on

dhcpDeployMode See DHCP fields for descriptions. Not applicable.

DhcpConfigData See DHCP fields for descriptions. Not applicable.

reInitialize A value of "true" reinitializes and reinstates the site.

The reInitialize attribute is automatically removed from the YAML file after it has run.

When set to "false", no action is taken.

true or false

id An optional Common Language Location Identifier (CLLI) or any desired identifier code.

AUSTTXBC

city The city where the site is deployed. Mandatory attribute. Austin

state The state where the site is deployed. Mandatory attribute. Texas

address The address where the site is deployed. Mandatory attribute. 1 Dell Way, RR, TX 78682, USA

country The country where the site is deployed. Mandatory attribute. USA

latLong Optionally, set the geographic coordinates to indicate the position of the site.

30.48921768077312, -97.67029215397606

DHCP fields

Table 11. DHCP Fields

Field Description Example supported values

dhcpDeployMode How to use DHCP with Bare Metal Orchestrator. Options are no DHCP server and a managed Kubernetes pod providing a DHCP server or relay.

none

server

relay

autoDiscoveryMode Top-level field for server discovery by DHCP. Not applicable

discoveryViaDhcp Set the server discovery by DHCP to automatic or none. auto or none

DhcpConfigData Top-level field for your DHCP configuration values. Not applicable

dhcpSubnet You can define as many subnets as you need. Not applicable

defaultLeaseTime Default lease time for this subnet, in seconds. 3000

maxLeaseTime Maximum lease time for this subnet, in seconds. 6000

netmask The netmask for the subnet. 255.255.255.0

optionBroadcastAddress The broadcast address that is provided to clients for this subnet.

IPv4 address

optionRouters The gateway that is provided to clients for this subnet. IPv4 address

optionSubnetMask The subnet mask that is provided to clients for this subnet. 255.255.255.0

subnet The IP address of the subnet. IPv4 address

dhcpPool Define one or more DHCP IP pools. Not applicable

YAML schema 59

Table 11. DHCP Fields (continued)

Field Description Example supported values

allowMembers Define what can lease an IP address from this DHCP IP pool. This must be a vendor class identifier that is specified in the vendorClassIdentifier list.

For example:

iDRAC

denyMembers Define what cannot lease an IP address from this DHCP IP pool. This must be a vendor class identifier that is specified in the vendorClassIdentifier list.

Vendor class identifiers are transmitted with DHCP requests for IP addresses from clients.

For example:

A Linux server could send Linux 2.4.34 i686

endRange DHCP pool starting IP address. IPv4 address

startRange DHCP pool ending IP address. IPv4 address

interfaces A comma-separated list of network interface names that the DHCP server services clients on.

ens192, ens224

domain Top-level domain for your DHCP server. example.com

dns A comma-separated list of DNS server IP addresses. IPv4 addresses

additionalDhcpConfig A semicolon-separated list of DHCP server configuration commands.

See: ISC DHCP 4.4 Manual Pages - dhcpd.conf

vendorClassIdentifier Every DHCP client includes a vendor class identifier in DHCP requests that it sends to a DHCP server. A vendor class identifier is a text string that identifies the type of device.

For iDRACs, the vendor class identifier is "iDRAC".

This setting is used in the allowMembers and denyMembers fields. This action configures the DHCP server to only provide IP addresses from a pool to devices that have the given vendor class identifier.

A DHCP pool that has allowMembers: "iDRAC" causes the DHCP server to only allocate IPs in this pool to iDRACs. In this example, "iDRAC" must also appear in the vendorClassIdentifier list.

NOTE: For Supermicro servers, the vendor class identifier is udhcp 1.23.1 for the SYS-1019P-FRN2T model.

For Dell switches, the vendor class identifier is onie_vendor:x86_64-dellemc.

For HPE iLO servers, the vendor class identifier is CPQRIB3.

All values are supported.

dhcpRelayConfig Top-level field for DHCP relay configuration. Not applicable

dhcpForwardIpAddress The forwarding IP address of the external DHCP server. IPv4 addresses

bootSize The size of the primary boot image to download from the TFTP server. It is calculated from the size of the boot file in bytes divided by 512.

370

inbandIP The private IP from which the PXE InBand VLAN is configured.

A valid IP address

60 YAML schema

Server and hardware profile field definitions

The following sections describe server and hardware profile field definitions.

Server connectivity field definitions

This table contains definitions and supported values for the following fields in the server.

Table 12. Server connectivity field definitions

Field Description

bmcEndPoint The IP address of the BMC.

userName Add a BMC username.

password Add a BMC password.

NOTE: If the username and password credentials were added to the cred.yaml file, then adding them here using the

userName and password attributes is optional.

Power field definitions

The following table contains the definition and supported values for the power state.

Table 13. Power field definitions

Field Description Supported values

powerstate Power status of the server. On or Off

Server location field definitions

The following table describes the server location fields and their supported values.

Table 14. Server location field definitions

Field Description Supported values

placement rack: The rack name or number.

NOTE: Row numbers are the rack number within the row.

For example:

Rack 922

row: The row that the rack containing the server resides in. For example:

Row 80

postaladdress building: The name of the building where the server is located. For example:

Dell RR4

room: The name or number of the room where the server is located. For example:

Room 50

Server and profile telemetry field definitions

The following table describes the server and profile telemetry fields in the server YAML file and their supported values.

YAML schema 61

Table 15. Server and hardware profile telemetry field definitions

Field Description Supported values

telemetryEnable To enable telemetry on a server. Enabled or disabled

reconcileTelemetry To configure telemetry metrics. True or false

Operating system field definitions

This section provides field definitions and configurable values that Bare Metal Orchestrator supports for operating system server deployments.

The following table lists common operating system attributes that you configure when deploying an operating system on a server.

Table 16. 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:

esxi6.7u3

rhel8.4

suse15.3

wrmedia

overwriteInstallation Optional attribute used to overwrite the existing operating system that is installed on the server when you perform an operating system upgrade.

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

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.

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.

For example:

www.dell.com

dnsServer Specifies a list of DNS serverIPv4 IP address for ESXi operating system.

For example:

127.0.0.1

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:

62 YAML schema

Table 16. 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 RAID: Disk.Virtual.0:RAID.Slot.2-1

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, if an operating system is deployed on RAID Volume1, and you want to install the operating system on RAID Volume2, 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, then the ESXi OS installation installs onto the default hard drive.

SDCARD

NVME

RAID

HBA

BOSS

The following table lists configurable ESXi-specific operating system settings. For all operating system deployment settings and the preseed sample content, see Sample operating system deployment YAML files - ESXi .

Table 17. 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

YAML schema 63

Table 17. ESXi-specific operating system settings (continued)

Field Description Supported values

Preseed configdata settings

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 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 configurable openSUSE-specific operating system settings. For all operating system deployment settings and the autoyast sample content, see Sample operating system deployment YAML files - openSUSE .

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.

64 YAML schema

For example:

suse1

Table 18. 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

YAML schema 65

Table 18. 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

66 YAML schema

Table 18. 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 setup for root access on the VM.

For encrypted config:

true or false

The following table lists configurable Red Hat Enterprise Linux-specific operating system settings. For all operating system deployment settings and the kickstart sample content, see Sample operating system deployment YAML files - Red Hat Enterprise Linux.

Table 19. 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.

YAML schema 67

Table 19. Red Hat Enterprise Linux-specific operating system settings (continued)

Field Description Supported values

lang Set the server language. The default is en_US.

See the Red Hat website for a complete list of supported languages.

Example: es_ES

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 the sample YAML file

selinux Enable or disable Security-Enhanced Linux (SELinux) for the server.

--disabled

--enforcing

68 YAML schema

Table 19. Red Hat Enterprise Linux-specific operating system settings (continued)

Field Description Supported values

--permissive

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 Wind River Cloud Platform operating system settings. For all operating system deployment settings and the kickstart sample content, see Sample operating system YAML files - Wind River Cloud Platform.

Table 20. 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 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.

NVME

SDCARD

RAID

HBA

BOSS

YAML schema 69

Table 20. Wind River Cloud Platform operating system settings (continued)

Field Description Supported values

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.

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

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

Firmware field definitions

The following table contains definitions and supported values for the fields in firmware.

Table 21. Firmware field definitions

Field Description

firmwareNames List of firmware media to install.

70 YAML schema

Table 21. Firmware field definitions

Field Description

Specify all the firmware names if you are performing multiple firmware updates.

NOTE:

The firmware name must match the metadata name value in the firmware media object.

BIOS attribute definitions

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

Table 22. 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

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 23. Boot settings

Attribute Description Supported values Supported vendors

setBootOrderEn Enables the boot option on the next boot for the list of FQDDs.

For example:

Disk.Bay.22

NIC.PxeDevice.1-1

PCIeExtender.Slot.1

Dell

setBootOrderDis 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 are specified in the boot order are specific to a server. When you update the boot order in a hardware profile, make sure the same boot devices are on all the servers that are targeted by the hardware profile.

setBootOrderFqdd1 Specifies a list of FQDDs that represents the boot list to be applied on the next boot.

The system attempts to boot to 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 until the boot is successful, or no more boot options are found.

NOTE: Do not define bootOrder in Boot

attribute definitions while using these attributes.

setBootOrderFqdd2

setBootOrderFqdd3

setBootOrderFqdd4

YAML schema 71

Table 23. Boot settings (continued)

Attribute Description Supported values Supported vendors

setLegacyHddOrderFq dd1

Specifies a list of legacy hard drives to be applied on the next boot when bootMode is set to Bios.

For example:

RAID.Integrated.1-1

RAID.*.*

*.*.*

Dell

setLegacyHddOrderFq dd2

bootMode Specifies the boot mode for operating system installation.

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 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:

You must install the operating system in the same boot mode. If you switch boot modes, this may prevent the system from booting.

Do not define bootOrder in Boot attribute

definitions while using bootMode.

Bios or Uefi Dell

Supermicro

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

OneTimeBootSeq

OneTimeHddSeq

Disabled

Dell

BootSeqRetry 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 second time-out period, depending on if this field is set to Reset or Enabled.

Enabled

Reset

Disabled

Table 24. System profile settings

Attribute Description Supported values Supported vendors

procPwrPerf Enables selection of CPU power management methodology.

SysDbpm 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.

OsDbpm 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 idle or underused cores to save power.

MaxPerf 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.

SysDbpm, OsDbpm, or MaxPerf

Dell

Supermicro

72 YAML schema

Table 24. System profile settings (continued)

Attribute Description Supported values Supported vendors

This mode drives processor frequency to the maximum across all cores and is always preferred for latency-sensitive environments.

memFrequency Enables selection of the system memory speed. NOTE: You can save more power by reducing the memory frequency, at the expense of reduced performance.

MaxPerf, 3200 MHz

2933 MHz, 2666 MHz

2400 MHz

2400 MHz

2133 MHz

1866 MHz

MaxReliability

procTurboMode Enables or disables processor turbo boost mode.

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

Enabled or Disabled

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

Enabled or Disabled

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

NOTE: When set to Enabled or Autonomous,

memory latency and frequency jitter may increase.

Enabled

Disabled

Autonomous

writeDataCrc Enables or disables the Write Data CRC. Enabled or Disabled

memPatrolScrub Sets the memory patrol scrub frequency. Patrol scrubbing searches the memory for errors and then repairs correctable errors, which prevents memory errors from accumulating.

NOTE:

Set to Extended to frequently scrub the entire memory array to further increase system reliability.

Set to Standard to scrub the entire memory array once in a 24-hour period.

Set to Disabled to stop patrol scrubbing.

Extended, Standard, or Disabled

memRefreshRate The memory controller periodically refreshes the data in the memory.

Set to 1x to indicate the frequency at which memory is refreshed.

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

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

1x or 2x Dell

Supermicro

uncoreFrequency Enables selection of the Processor Uncore Frequency. DynamicUFS or MaxUFS Dell

YAML schema 73

Table 24. System profile settings (continued)

Attribute Description Supported values Supported vendors

Set to DynamicUFS to allow the processor to optimize power resources across the cores and uncore during runtime.

energyPerformanceBias Enables selection of the energy-efficient policy.

The CPU uses this setting to manipulate internal processor behavior and determines whether to target higher performance or better power savings.

MaxPower

BalancedPerformance

BalancedEfficiency

LowPower

Dell

Supermicro

proc1TurboCoreNum Controls the number of turbo boost enabled cores for the Processor.

NOTE:

Set ProcTurboMode to Enabled and

ProcPwrPerf to MaxPerf on the server

before updating this field.

If this field value is greater than the number of available processor cores, the value gets automatically set to All instead of the given

value.

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

Dell

proc2TurboCoreNum

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

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

Enabled or Disabled

cpuInterconnectBusLin kPower

Enables or disables the CPU Interconnect Bus Link Power Management.

CAUTION: If this is Enabled, the CPU

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

CpuInterconnectBusSp eed

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 is supported by the processors.

Maximum Data Rate Dell

Supermicro

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

If this is Enabled, it may slightly reduce overall system power and performance.

NOTE: Some devices may become unresponsive or cause the system to become unresponsive when ASPM is enabled. For this reason, ASPM is only enabled for validated qualified cards.

Dell

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

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

NOTE: This attribute is read-only and cannot be edited.

For XR11: 0us - 500us

74 YAML schema

Table 24. System profile settings (continued)

Attribute Description Supported values Supported vendors

ProcessorC1AutoDemot ion

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

NOTE: These attributes are read-only and cannot be edited.

Enabled or Disabled Dell

ProcessorC1AutoUnDe motion

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

NOTE: These attributes are read-only and cannot be edited.

Enabled or Disabled

DynamicL1 This field only applies to the package level setting to allow dynamic entering lower power link state L1.

Enabled or Disabled

PackageCStates Enables or disables the package to transition to deeper C-states or limit to operational state.

Enabled or Disabled

SysProfile 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 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

WorkloadProfile Allows optimization of 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 turns modifies various BIOS settings to be optimized for the requested workload type.

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

WorkloadConfiguration Controls the BIAS settings for energy performance, which enables the BIOS to select a configuration that improves the performance on a

NOTE: This attribute is read-only and cannot be edited.

specific workload.

Dependent on the Workload Profile selected.

Dell

AcPwrRcvry Controls the system behavior after a power failure event.

On

YAML schema 75

Table 24. System profile settings (continued)

Attribute Description Supported values Supported vendors

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.

Set to Last for the system to turn on if the system was on at the moment when AC power was lost. The system remains off if the system was turned off when AC power was lost. In the case of an ungraceful shutdown, the system always turns on.

Off

Last

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

NOTE: This attribute is read-only and cannot be edited.

Enabled or Disabled

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

NOTE: This attribute is read-only and cannot be edited.

Enabled or Disabled

Table 25. System security settings

Attribute Description Supported Values Supported vendors

TpmSecurity 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 OnPbm, the BIOS stores the Trusted

Computing Group (TCG) compliant measurements to the TPM.

When set to OnNoPbm, the BIOS bypasses most pre-boot measurements.

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

NOTE: For Supermicro servers, the values OnPbm and OnNoPbm are handled the same as the On value.

For Dell Servers TPM 2.0: On or Off

For Dell Servers TPM 1.2:

OnPbm

OnNoPbm

Off

For Supermicro servers:

On

Off

OnPbm

OnNoPbm

Dell, Supermicro

MemoryEncryption Enables or disables the Intel Total Memory Encryption and Multi-Tenant (Intel TME-MT). When set to Disabled, 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

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

SingleKey

MultipleKeys

Disabled

Dell

PwrButton Enables or disables the power button on the front panel.

NOTE: For Supermicro, when the value is set to Disabled, pressing the power button causes

the system to turn off immediately in a legacy

Enabled or Disabled Dell

Supermicro

76 YAML schema

Table 25. System security settings (continued)

Attribute Description Supported Values Supported vendors

operating system. When the value is set to Enabled, pressing the power button for 4

seconds causes the system to turn off.

AcPwrRcvryDelay 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.

NOTE: You must ensure that the AcPwrRcvry value is set to On or Last in the Spec before you

can modify this attribute.

Immediate

Random

User-Defined

Dell

AcPwrRcvryUserDelay 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.

60s to 600s

UefiVariableAccess 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

InBandManageabilityIn terface

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

When set to Disabled, this prevents the operating system from changing the ME power capping settings, and blocks access to all in-band management tools. All management must be managed through or using out- of-band.

Enabled or Disabled

PasswordStatus 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

SysPassword The system password is the password that must be entered to allow the system to boot to an operating system. Changes to the system password take effect immediately.

Alpha-numerical with a maximum of 32 characters.

YAML schema 77

Table 25. System security settings (continued)

Attribute Description Supported Values Supported vendors

NOTE: The password is read-only if the password jumper (PWRD_EN) is not installed in the system.

SetupPassword The setup password is the password that must be entered to change any BIOS settings. However, the system password can be changed without entering the correct setup password if Password Status is set to Unlocked. Changes to the setup password take effect immediately.

NOTE: The password is read-only if the password jumper (PWRD_EN) is not installed in the system.

Alpha-numerical with a maximum of 32 characters.

SHA256SystemPassw ord

SHA256 hash of the system password. Maximum of 64 characters

SHA256SystemPassw ordSalt

Salt string that is appended to the system password before hash.

Maximum of 32 characters

SHA256SetupPasswor d

SHA256 hash of the setup password. Maximum of 64 characters

SHA256SetupPasswor dSalt

Salt string that is appended to the setup password before hash.

Maximum of 32 characters

Table 26. Memory settings

Attribute Description Supported values Supported vendors

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

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

Enabled or Disabled Dell,

Supermicro

memOpMode Indicates the memory operating mode:

OptimizerMode DRAM controllers operate independently in 64-bit mode and provide optimized memory performance.

SingleRankSpa reMode

The memory size reported to the operating system does not include the single rank spare portion.

MirrorMode The server maintains two identical copies of data in the memory. This allows the system to continue running even during a catastrophic memory failure.

FaultResilien tMode

When Non-Uniform Memory Architecture (NUMA) is enabled, some of the installed memory in every NUMA node is configured to create a fault resilient zone. Select hypervisors use this for host virtualization resilience.

For Dell PowerEdge 14th generation servers:

OptimizerMode

SingleRankSpareMode

MirrorMode, FaultResilientMode

For Dell PowerEdge 15th generation servers:

OptimizerMode

SingleRankSpareMode

MirrorMode, FaultResilientMode

NUMAFaultResilientMode

Dell

nodeInterleave Indicates if NUMA is supported. Enabled or Disabled Dell

Supermicro

78 YAML schema

Table 26. Memory settings (continued)

Attribute Description Supported values Supported vendors

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

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

This is a read-only field when SubNumaCluster is set to Enabled.

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

NOTE: Set to Disabled to avoid latency issues.

Enabled or Disabled Dell

oppSrefEn Enables or disables the opportunistic self-refresh feature.

Enabled or Disabled

DramRefreshDelay By enabling the CPU memory controller to delay running the REFRESH commands, you can improve the performance for some workloads.

By minimizing the delay time, it is ensured that the memory controller runs the REFRESH command at regular intervals.

For Intel-based servers, this setting only affects systems that are configured with DIMMs which use 8 Gb density DRAMs.

Performance or Minimum

MemoryTraining Selects the memory training configuration. Fast: Use previously saved memory training

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

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

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

Fast

Retrain at Next Boot

Enable

CECriticalSel Enables or disables the logging of correctable memory threshold errors.

Enabled or Disabled

Table 27. Processor settings

Attribute Description Supported values Supported vendors

logicalProc 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

YAML schema 79

Table 27. Processor settings (continued)

Attribute Description Supported values Supported vendors

procVirtualization Enables or disables the virtualization technology for the processor.

NOTE:

Enabled is the recommended setting because

disabling this setting should not impact system performance or power characteristics.

If procVirtualization is Disabled, you must

also disable proX2Apic.

Enabled or Disabled Dell

Supermicro

procAdjCacheLine Enabled optimizes the system for applications that require high utilization of sequential memory access.

Disabled optimizes the system for applications that require high utilization of random memory access.

Enabled or Disabled Dell

Supermicro

procHwPrefetcher Enables or disables the hardware prefetcher.

Enabled allows the processor to 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

Supermicro

procSwPrefetcher Enables or disables the software prefetcher.

Enabled allows the processor to 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

dcuStreamerPrefetc her

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

dcuIpPrefetcher Enables or disables DCU IP 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

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

SNC is a feature for breaking up the Last-level Cache (LLC) into disjointed clusters that is based on address range. Each cluster is bound to a subset of the memory controllers in the system. It improves average latency to the LLC.

This is a read-only field when NodeInterleave is Enabled.

For Dell PowerEdge 14th generation servers:

Enabled or Disabled

For Dell PowerEdge 15th generation servers:

Disabled or 2-way

Dell

Supermicro

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

Enabled or Disabled Dell

LlcPrefetch Enables or disables the Last Level Cache Prefetch. Dell

80 YAML schema

Table 27. Processor settings (continued)

Attribute Description Supported values Supported vendors

Supermicro

dynamicCoreAllocatio n

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

Disabled restricts the operating system capability to put the logical processors in idling state.

This is a read-only field when ProcPwrPerf is set to MaxPerf.

Dell

procX2Apic Enables or disable the x2APIC mode.

This is a read-only field when ProcVirtualization is Disabled.

Enabled or Disabled Dell, Supermicro

ProcessorRaplPrioriti zation

Enables or disables the Running Average Power Limiting to monitor and control the memory power in accordance to the BIOS settings.

Enabled or Disabled Dell

procCores 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 if you reduce the number of enabled cores. Most computing environments benefit more from a larger number of processing core. So, carefully weigh the disabling of cores to gain nominal performance enhancements.

For Dell PowerEdge 14th generation servers: All, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22

For Dell PowerEdge 15th generation servers: All, 1, 2, 4, 6, 8, 10, 12, 14, 16, 18, 20, 22, 24, and 26

Dell

Supermicro

AvxIccpPreGrantLice nse

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

AvxIccpPreGrantLev el

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

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

For Dell PowerEdge 15th generation servers: IccpHeavy128

256 Light

256 Heavy

512 Light

512 Heavy

ProcAvxP1 Selects the AVX P1 level. Normal

Level1

Level2

Dell

Supermicro

DirectoryMode Enables or disables directory mode. Enabled or Disabled Dell

MadtCoreEnumeratio n

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

Round Robin or Linear

YAML schema 81

Table 27. Processor settings (continued)

Attribute Description Supported values Supported vendors

Sockets for a linear distribution of interrupt controllers for the OS.

XptPrefetch XPT prefetch is a mechanism that enables the MS2IDI to take a read request that is being sent to the LLC and speculatively issue a copy of that read to the memory controller.

Enabled or Disabled

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

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

Enabled or Disabled

ControlledTurbo 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 or Disabled

OptimizerMode Determines the optimization of the CPU Performance. Auto: Enables when CPU Power Management is

set to Max Performance.

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

Disabled: Turns off the feature.

Auto, Enabled, Disabled

Table 28. Serial communication settings

Attribute Description Supported values Supported vendors

serialComm Select serial communication devices in BIOS. OnNoConRedir

OnConRedirAuto

OnConRedirCom1

OnConRedirCom2, or Off

Dell

extSerialConnector Associates the extSerialConnector to Serial1, Serial2, or the RemoteAccDevice.

Serial1, Serial2, or RemoteAccDevice

serialPortAddress Sets the port address for the serial devices. NOTE: Only Com2 is used for Serial Over LAN

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

Com1 or Com2

For Dell PowerEdge 14th generation servers, Xr11 and XR12 Dell PowerEdge servers:

Com1

For Dell PowerEdge 15th generation servers: Com2

Dell

Supermicro

failSafeBaud Specifies the failsafe baud rate for console redirection.

If the BIOS fails to determine the baud rate automatically, the specified baud rate is used.

115200

57600

19200

9600

Dell

conTermType Sets the terminal type for a remote console. Vt100Vt220 or Ansi

82 YAML schema

Table 28. Serial communication settings (continued)

Attribute Description Supported values Supported vendors

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

Enabled or Disabled

Table 29. Integrated device settings

Attribute Description Supported values Supported vendors

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

Set to Enabled to boot to a virtualization operating system that recognizes SR-IOV devices.

Enabled or Disabled Dell

Supermicro

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

MemoryMappedIOH Selects the MMIO base amount. NOTE: The MMIO base default is 56TB. You should not change the default value unless addressing a known issue.

When set to 12TB, the system maps the MMIO base to 12TB. Enable this feature for an OS that requires 44bit PCIe addressing.

When set to 512GB, the system maps the MMIO base to 512GB, and reduce the maximum support for memory to less than 512GB. Enable this option only for the 4 GPU DGMA issue.

12TB

56TB

512GB

Dell

UsbPorts 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. You can enable or disable front ports dynamically without resetting the system.

The USB keyboard and mouse still functions 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 Ports On

Only Back Ports On

All Ports Off

All Ports Off (Dynamic)

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

On or Off

EmbNic1Nic2Nic3Nic 4

Enables or disables the OS interface of the embedded NIC1, NIC2, NIC3 and NIC4 controller.

NOTE: If set to Disabled (OS), the embedded NICs may still be available for shared network access by the embedded management controller. This function must be configured using the NIC management utilities that are provided with your system.

Enabled or Disabled (OS)

IoatEngine Enables or disables the I/O Acceleration Technology (I/ OAT). I/OAT are DMA features that are designed to accelerate network traffic and lower CPU utilization.

NOTE: Only enable this feature if the hardware and software support I/OAT.

Enabled or Disabled

EmbVideo Enables or disables the use of the Embedded Video Controller as the primary display.

Enabled or Disabled

YAML schema 83

Table 29. Integrated device settings (continued)

Attribute Description Supported values Supported vendors

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. The BIOS output displays to both the primary add-in video and the embedded video during POST and pre-boot environment. The embedded video is disabled right before the operating system boots.

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

SnoopHldOff 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.

256 Cycles

512 Cycles

1K Cycles

2K Cycles

4K Cycles

8K Cycles

16K Cycles

32K Cycles

64K Cycles

128K Cycles

OsWatchdogTimer If the system stops responding, this watchdog timer helps in the recovery of your operating system (OS). 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

PCIRootDeviceUnhid e

If set to Enabled, root ports of all the empty slots are accessible to the BIOS and OS.

Enabled or Disabled

AutoDiscovery Allows BIOS to dynamically scan for PCIe devices rather than relying strictly on system slot definitions. The Platform Default setting strictly follows the system slot definitions when configuring each PCIe slot. The Auto Discovery setting analyzes the installed PCIe cards and determines the correct configuration for each slot. This may include bifurcation of the slot for multiple devices. Manual Control allows the user to override bifurcation settings for each slot.

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

Platform Default Bifurcation

Auto Discovery of Bifurcation

Manual Bifurcation Control

Slot1 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

Slot2

Slot3

84 YAML schema

Table 29. Integrated device settings (continued)

Attribute 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 will not be available to the operating system.

When set to Boot Driver Disabled, the Option ROM and UEFI driver from that slot will not run during POST. As a result, the system will not boot from the card, and its pre-boot services will not be 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 the similar devices in the system. In this case, to make sure that the Option ROM and UEFI driver do not run, you must select Boot Driver Disabled for all the cards from the same manufacturer (including its integrated device versions such as NDCs).

Table 30. Network settings

Attribute Description Supported values Supported vendors

pxeDev1EnDis Enables or disables the device for PXE Boot selection.

For Supermicro servers, the pxeDev1EnDis attribute enables the IPv4PXESupport.

NOTE: Only pxeDev1EnDis is supported for Supermicro

Enabled or Disabled Dell

Supermicro

pxeDev2EnDis Dell

pxeDev3EnDis

pxeDev4EnDis

pxeDev1Interface Specifies the NIC interface used for each PXE device.

For Supermicro servers, the pxeDev1Interface attribute specifies the NIC interface which is used for PXE boot. For Supermicro servers only, the pxeDev1Interface attribute is supported for both Uefi and Bios mode.

The interface value can be changed only if the corresponding PXE device is enabled.

NOTE: Only pxeDev1Interface is supported for Supermicro

Available NIC Ports. For example:

"NIC.Integrated.1-1 "

Dell

Supermicro

pxeDev2Interface Dell

pxeDev3Interface

pxeDev4Interface

Table 31. SATA Settings

Attribute Description Supported values Supported vendors

EmbSata Determines the mode of the Embedded SATA. ACHI

RAID Mode

Off

Dell

SecurityFreezeLock Sends Security Freeze Lock command to the Embedded SATA drives during POST.

NOTE: This option is only applicable to AHCI mode.

Enabled or Disabled

YAML schema 85

Table 31. SATA Settings (continued)

Attribute Description Supported values Supported vendors

WriteCache Sends Enable or Disable Write Cache command to the Embedded SATA drives during POST.

NOTE: This option is only applicable to AHCI mode.

Enabled or Disabled

Table 32. Redundant OS control settings

Attribute Description Supported values Supported vendors

RedundantOsLocation Specifies the backup device for the Redundant OS Control feature.

When Redundant OS Boot is set to Enabled, the BIOS boots to this device. 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 the Redundant OS state and not be available to be changed in Integrated Devices.

Embedded SATA: must be set to anything other than Off for SATA ports to show up as optional backup devices.

SATA Port A or NONE Dell

Table 33. Miscellaneous settings

Attribute Description Supported values Suported vendors

Numlock Determines whether the system boots with Num Lock enabled or disabled. This does not apply to 84- key keyboards. When On, the rightmost keys on the keyboard

function like those on a numeric calculator. When Off, they function as cursor-control keys.

On or Off Dell

ErrPrompt 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

ForceInt10 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 in order 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

DellWyseP25BIOSAccess 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 prevents the keyboard and mouse access to Diagnostics, Boot Options, and other Pre- OS functionality.

Enabled or Disabled

86 YAML schema

Table 33. Miscellaneous settings (continued)

Attribute Description Supported values Suported vendors

PowerCycleRequest 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 will

temporarily be forced into a lower power state, similar to removing and replacing AC.

None or FullPowerCycle

BMC attribute definitions

A short list of BMC attributes are supported for operating system deployments:

rfsIgnoreCertWarning serialRedirectEnable

Table 34. DNS settings

Attribute Description Supported values Supported vendors

DNSFromDHCP Enables or disables DHCP. Enabled or Disabled Dell

nameServers DNS server IP address. You can configure up to two DNS servers.

For Supermicro, you must configure one DNS server only.

For HPE iLO servers, this field is read-only.

For example:

11.11.11.11

Dell

Supermicro

HPE iLO

DNSDomainName DNS Domain name For example:

dell.com

Dell

DNSRacName The name of the server. The default format is: SERVER- .

For example:

SERVER-D2T5MH3

Dell, Supermicro

Table 35. NTP settings

Attribute Description Supported values Supported vendors

protocolEnabled Enables or disables the NTP server on the BMC. NOTE: This configuration overwrites the existing NTP configuration.

True or False Dell

Supermicro

HPE iLO ntpServers NTP serverIPv4 IP address. You can configure up to three

NTP servers. NOTE: For HPE iLO servers, set the protocolEnabled attribute to true 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 36. Connectivity settings

Attribute Description Supported values Supported vendors

topologyLLDP Enables or disables the LLDP topology information. Enabled or Disabled Dell

osBmcPassThroughSt ate

Manages the IMC administrative state.

YAML schema 87

Table 36. Connectivity settings (continued)

Attribute Description Supported values Supported vendors

ipmiLanEnable Enables or disables the BMC IPMI over LAN interface.

vlanEnable Enables or disables the BMC VLAN capabilities.

vlanID Specifies the VLAN ID for the network VLAN configuration.

CAUTION: You can lose BMC access if you change this field. This action impacts network connectivity.

1 to 4094

VirtualConsolePluginT ype

Specifies the virtual console plugin type.

To update this attribute on Supermicro servers, the virtual console needs to be disabled first. The virtual console plugin 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

eHTML5

Dell, Supermicro

Table 37. Service settings

Attribute Description Supported values Supported vendors

snmpAgentEnable Enables or disables the Simple Network Management Protocol (SNMP) agent on the BMC.

Enabled or Disabled Dell

snmpAgentCommuni tyName

Specifies the SNMP community name to be used for SNMP Agents.

The name can have up to 31 non-blank characters.

For example:

Public

snmpProtocol SNMP protocol. All or SNMPv3

snmpDiscoveryPortN umber

SNMP agent port on the BMC. 1 to 65535; except 22, 80, and 443

timeZone Select the time zone from the drop-down list. The time zone can have up to 32 characters.

For example:

US/Central, Universal, UCT, and so on

Dell

Supermicro

HPE iLO

Table 38. BMC user account settings

Attribute Description Supported values Supported vendors

userName A unique username. NOTE: Special characters cannot be entered in the user name.

For example:

Root

Dell

Supermicro

HPE iLO password Password for the user account. For example:

Root

roleId The group privilege level that is assigned to the BMC user.

For example, user privilege levels for an iDRAC are as follows:

Administrator - Log in to iDRAC, Configure iDRAC, Configure Users, Clear Logs, Control and Configure . System, Access Virtual Console, Access Virtual Media, Test Alerts, and Execute Debug Commands.

iDRAC example:

Administrator

Operator

Read Only

88 YAML schema

Table 38. BMC user account settings (continued)

Attribute Description Supported values Supported vendors

Operator - Log in to iDRAC, Configure iDRAC, Control and Configure System, Access Virtual Console, Access Virtual Media, and Execute Debug Commands.

Read Only - Log in to iDRAC.

None

enabled Enables or disables user privileges based on the role. True or False Dell

resetPassword Indicates whether a password change is required for the user.

Dell

Supermicro

HPE iLO

Table 39. Ignore certificate warning message setting

Attribute Description Supported values

rfsIgnoreCertWarning Ignore certificate warning message. Yes or No

Table 40. Serial redirect setting

Attribute Description Supported values

serialRedirectEnable Enables or disables serial console redirection. Enabled or Disabled

Table 41. Network settings

Attribute Description Supported values Supported vendors

address IP address that is associated with the BMC (not the managed system).

NOTE: Updating the IP address also updates the BMC endpoint.

IP address Dell

HPE iLO

gateway Default network gateway IP address configured for the BMC.

subnetMask TCP/IP subnet mask that is configured for the BMC. It identifies the parts of the IP address that are the Extended Network Prefix and the Host Number.

TCP/IP subnet mask

CAUTION:

Changing any of the network settings results in losing BMC access, which impacts network connectivity.

Boot attribute definitions

Table 42. Boot settings

Attribute Description Supported values Supported vendors

bootOrder Specifies a list of FQDDs and boot sources that represent the boot list to be applied on the next boot.

The system attempts to boot to 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 until the boot is successful, or no more boot options are found.

Before updating the bootOrder in the Server YAML file, you can view the current bootOrder in the Server status, under the

Examples:

Disk.Bay.22:Enclosure.Internal .0-1:PCIeExtender.Slot.1

NIC.PxeDevice.1-1

Dell

Supermicro

HPE iLO

YAML schema 89

Table 42. Boot settings (continued)

Attribute Description Supported values Supported vendors

boot section. Update the bootOrder in the Spec section to change the order of the boot sources.

NOTE: The bootOrder can be modified on HPE and Supermicro servers when the boot mode is in UEFi or

BIOS mode.

For Supermicro servers, you can provide shortcut keywords to specify the network and hard disk boot options. For example, in BIOS boot mode:

"Hard Disk "Network"

In UEFI boot mode:

"UEFI Hard Disk" "UEFI Network"

HddOrder Specifies a list of hard drives to be applied in order of priority, on the next boot.

You can view the current HddOrder in the Server status, under the boot section, if the current boot mode is in Bios mode. To update the HddOrder, edit the HddOrder field under the Boot settings, in the Spec section of the Server YAML file. You can only modify the HddOrder setting on a server when the bootMode is in Bios mode.

NOTE: For Supermicro servers, you can set one or more of the HddOrder options to Disabled.

Examples:

sSATA P1: INTEL SSDSC2KB480G8 (SATA,Port:1)

sSATA P0: INTEL SSDSC2KB480G8 (SATA,Port:0)

Dell

Supermicro

Hardware profile apply and preview definitions

The following table describes the attribute field definitions used to apply the hardware profile to servers and to preview the server configuration status.

Table 43. Hardware profile apply and preview definitions

Attribute Description Supported values

apply Apply the configuration settings of the hardware profile to the targeted servers.

Servers can be targeted using either selectors and labels or by listing the server names directly in the hardware profile.

true or false

preview Collect status information for the servers that the hardware profile targets. Server status is shown in the status section of the hardware profile when you run bmo describe hardwareprofile -f to describe the hardware profile.

Targeted servers that are in a non-ready state are shown under failedList.

The hardware profile configuration is only applied to the targeted servers when the apply attribute is set to true.

NOTE: You cannot set both the apply and preview attributes to true at

the same time in the hardware profile.

true or false

90 YAML schema

Hardware profile targeting attribute definitions

The following table describes the field definitions for the Hardware profile attributes used to target specific servers for configuration.

Table 44. Hardware profile serverList definitions

Attribute Description Supported values

serverList A list of servers that you want the hardware profile to specifically target for configuration.

Add the serverList attribute to the spec section of the hardware profile, then list the server name and namespace for each server to target. For example:

serverList: - name: server22 namespace: metalweaver - name: server21 namespace: metalweaver - name: server30 namespace: metalweaver

The maximum character limit for server name is 51. The first and last character must be alphanumeric.

NOTE: Hardware profiles that are created using the Bare Metal Orchestrator Web UI already have a default selector called profileName: profile.

You can add custom selectors, but do not modify the default selector.

Alphanumeric characters (a to z, 0 to 9), dash (-), and period (.)

selectors User-defined selectors are added in the spec section of the hardware profile and are used to target specific servers for configuration. You can specify one or multiple selectors and their value. For example:

spec: selectors: hwprofile: hw-config001

The hardware profile settings are applied to servers that have a label with matching values.

The maximum character limit is 63. The first and last character must be alphanumeric.

CAUTION: Do not name the selector profile. This name is reserved

for internal operations.

Alphanumeric (a to z, A to Z, 0 to 9), dash (-), underscore (_), period (.), or can be left empty.

Server provisioning status

The following figure illustrates different provisioning states that the server transitions through:

YAML schema 91

The following table describes the provisioning status of a server:

Table 45. Server provisioning status

Status Description

Ready A server goes into the Ready state after a successful command execution. It also indicates that Bare Metal Orchestrator is ready to run the next command in sequence. For example, if Initialize is complete, the next command CollectingInventory starts. The state changes back to Busy when the command execution is in progress. For more information about the commands that run during server provisioning, see Server command executing status.

Busy Indicates that command execution is in progress.

Failed Indicates a failure in the command execution even after maximum retries. This can happen in several scenarios: There is a configuration mismatch between the specification and the status in server profiles. During retry, the state changes to Busy. However, the command execution starts only after a reconciliation

trigger.

NOTE: The provisioning states described are applicable for servers and switches.

Server command executing status

The command executing status indicates the commands that run during server provisioning in Bare Metal Orchestrator. Use the status to track the progress of a server at a granular level.

The command executing status is useful in the following scenarios:

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

The following table describes the server command states and are listed in the order in which they are run when onboarding a server.

Table 46. Server command executing states

Server command status Description

Initialize To initialize server settings.

CollectingMetrics To collect metrics.

FactoryReset Resets server to the default factory settings.

CollectingInventory To collect inventory.

CollecctingTelemetryInventory Collects telemetry inventory if telemetry is enabled.

StackDeploy To deploy stacks.

92 YAML schema

Table 46. Server command executing states (continued)

Server command status Description

UpdateBMCIPv4Settings To update server IPv4 settings.

UpdateBMCAttributes To update BMC attributes.

UpdateBMCDNSAttributes To update BMC DNS attributes.

BMCUserOperations To perform BMC user CRUD operations.

RAIDOperations To perform RAID operations.

BossRAIDOperations To perform BOSS RAID operations to create RAID1 type volume.

UpdatingBootSettings To update Boot settings.

UpdatingBIOSAttributes To update BIOS attributes.

UpdatingFirmware To update Firmware.

UpdateNICAttributes To update NIC adapter settings.

UpdatingBMCNTPSettings To update BMC NTP settings.

OSInstall To install ESXi, RHEL, and WR OS.

OSUpgrade To upgrade ESXi

UpdatingLocation Updating the location

Decommission To decommission a server by deleting all the physical drives in the server.

EnablingTelemetry To enable telemetry on servers.

ConfiguringMetrics To configure telemetry metrics.

PowerState To power on or power off a server.

RAID attribute definitions

The following table describes the RAID attributes and their supported values.

Table 47. RAID attribute definitions

Attribute Description Supported values

deleteNonMatchingVol umes

Bare Metal Orchestrator checks to see if the RAID configuration (volume names) mentioned in the .yaml file matches the RAID configuration of the server or not.

If the configuration matches, no changes are made in the server.

If the configuration does not match and the value for deleteNonMatchingVolumes is defined as:

true, the non-matching RAID volumes are deleted.

false, the non-matching RAID volumes are retained but Bare Metal Orchestrator does not monitor the non-matching RAID volumes.

The default value is false.

true or false

raidVolumes List of RAID volumes. Not applicable

name: A unique descriptive name for the RAID volume. This is a mandatory field.

raidType: RAID type for the virtual disks. This is a mandatory field. RAID0

RAID1

YAML schema 93

Table 47. RAID attribute definitions (continued)

Attribute Description Supported values

RAID5

RAID10

minCapacityBytes: The minimum size in bytes that Bare Metal Orchestrator requires to create RAID volumes. This is a mandatory field.

numberofDrives: The minimum number of drives required for RAID configuration. The valid values depend on the selected RAID type.

RAID 0-2

RAID 1-2

RAID 5-3

RAID 10-4

mediaType: The physical disk type present in the system.

The default value is HDD.

Solid-state Drive (SSD) or Hard Disk Drive (HDD)

Raid: Specifies whether to create the Raid Volume with a Software Raid or a Hardware Raid. If the Raid value is empty, any available Raid storage controller is used. Yes: Creates the Raid Volume with a Software Raid.

No: Creates the Raid Volume with a Hardware Raid.

A Software Raid Volume and a Hardware Raid Volume cannot be present on the same server. You must select one or the other.

NOTE: The Raid attribute is supported only for RHEL.

Yes or No

Network adapter attribute definitions

The following table describes the network adapter attributes and their supported values. SR-IOV configuration can be enabled or disabled in the network adapter settings.

Table 48. Network adapter attribute definitions

Attribute Description Supported values Supported vendors

nic Displays a list of the network adapter IDs and their settings.

Not applicable Dell

networkAdapterID Displays the network adapter ID. Not applicable Dell

HPE iLOnetworkAdapterSettings Displays the configuration settings for the network adapter.

Not applicable

Table 49. Nic settings attribute definitions

Attribute Description Supported values Supported servers

virtualizationMode Enter SRIOV to enable the port, which is configured for SR-IOV. Enter NONE to disable the port configured for SR-IOV.

SRIOV or NONE

blnkLeds NIC Interface Blink LEDs NOTE: This is a read-only field and cannot be edited.

Not applicable

numberVFAdvertised NIC Interface PCI Virtual Functions Advertised NOTE: This is a read-only field and cannot be edited.

1 to 64 with increments of 8 XR11

94 YAML schema

Table 49. Nic settings attribute definitions (continued)

Attribute Description Supported values Supported servers

MaxPfMsixVectors NIC Interface Maximum Number of PF MSI-X Vectors

0 to 512 inclusive

autodetectSpeedExclude Mask

NIC Interface Autodetect Speed Exclude Mask NOTE: This is a read-only field and cannot be edited.

0 to 4095 inclusive

adapterErrorRecovery NIC Interface Adapter Error Recovery Enabled or Disabled

hideSetupPrompt NIC Interface Hide Setup Prompt Read only in 14G with value Int19h

XR11

XR12

15G

setupKey NIC Interface Setup Key Stroke Broadcom_SetupKeyCtrlS

Broadcom_SetupKeyCtrlB

XR11

XR12

bannerMessageTimeout NIC Interface Banner Message Timeout 0 to 14 inclusive

Table 50. Network Port attribute definitions

Attribute Description Supported values Supported servers

rDMANICModeOnPort NIC interface and RDMA Mode Enabled or Disabled

MsixVectorsPerVf NIC Interface Number of MSI-X Vectors per VF

0 to 128 inclusive

forwardErrorCorrection NIC Interface Link FEC Broadcom_ForwardErrorCorrectionCL74

Broadcom_ForwardErrorCorrectionCL91

Broadcom_ForwardErrorCorrectionCL74CL 91Both

Disabled

operationalLnkSpeed 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 Auto-negotiation Protocol Broadcom_ANProtocolIEEEandBAM

Broadcom_ANProtocolIEEEandConsortium

Broadcom_ANProtocolIEEE8023by

Broadcom_ANProtocolBAMOnly

Broadcom_ANProtocolConsortiumOnly

mediaAutoDetect NIC Interface Media Auto Detect Enabled or Disabled

defaultEVBMode NIC Interface Default eVB Mode VEB

YAML schema 95

Table 50. Network Port attribute definitions (continued)

Attribute Description Supported values Supported servers

VEPA

None

portLinkTraining NIC Interface Port Link Training Enabled or Disabled XR11

bootOptionROM NIC Interface Option ROM Enabled or Disabled XR11

XR12

15G

legacyBootProto NIC Interface Legacy Boot Protocol PXE, NONE All

bootStrapType NIC Interface Boot Strap Type NOTE: Read-only in 14G with value Int19h

AutoDetect

BBS

Int18h

Int19h

wakeOnLan NIC Interface Wake On Lan Enabled or Disabled

vLanMode NIC Interface Virtual Lan Mode Enabled or Disabled

bootRetryCnt NIC Interface Boot Retry Count NoRetry

1Retry through to 6Retries

IndefiniteRetries

permitTotalPortShutdo wn

NIC Interface Permit Total Port Shutdown

Enabled or Disabled

Metric attribute definitions

The following table describes the metric attributes that are collected for inclusion in the metrics report. The attributes selected determine which statistics are collected for the metrics report.

Table 51. Metric collection attribute definitions

Attribute Description Supported vendors

pollFrequencyMins Statistics are collected every 15 minutes when metrics collection is configured for Bare Metal Orchestrator. Minimum value is 15.

Dell

HPE iLO CPUUtilization Bare Metal Orchestrator collects the CPU utilization statistics for all servers as a

percentage.

MemoryUtilization Bare Metal Orchestrator collects system memory usage statistics as a percentage. Not all platforms support collection of this data.

PowerConsumption Bare Metal Orchestrator collects the power consumption statistics for all CPUs, DIMMs, system input, and system output as watts.

Temperature Bare Metal Orchestrator collects device temperature sensor metrics in degrees Celsius.

Reinitialize attribute definition

The following table describes the reInitialize attribute and supported values.

96 YAML schema

Table 52. Reinitialize attribute definition

Attribute Description Supported values

reInitialize Bare Metal Orchestrator reinitializes and reinstates the server (or servers).

When a server is not in a failed state, Bare Metal Orchestrator does the following:

1. Reruns inventory against the server. 2. Reconciles the server. 3. Reapplies any configuration profile that targets the server and reinstates

the server.

For a server that is in the failed state, Bare Metal Orchestrator takes the server out of the failed state before reinitializing the server.

When set to "false", no action is taken.

The reInitialize attribute is automatically removed from the YAML file after it has run.

true or false

Server decommissioning field definitions

The following table contains definition and supported values for fields specific to baseline profiles used to decommission a server.

Table 53. Server decommissioning field definitions

Field Description Supported values

selectors Locates the server to be decommissioned. You must include the profile label. You can also add custom selectors to further specify a server, or edit a server's configuration profile to change its label to the one in the baseline hardware profile.

For example, profile: decommission Dell

SecureEraseDrives Erases all Secure Erase or cryptographic erasure capable disks. This field applies to physical disks including disks used in RAID volumes.

CAUTION: All information is completely and permanently erased.

NOTE: SD card erasure is not supported.

true or false

iDRAC factory default setting field definitions

The following table contains definition and supported values for fields specific to reset certain iDRAC system components to factory default.

NOTE:

After the factory reset, wait at least five minutes before you onboard a server.

Table 54. iDRAC factory default setting field definitions

Field Description Supported values Supported vendors

factoryResetBMC Reset BMC attributes to factory defaults. If set to true, resets to the value specified in bmcResetType.

true or false Dell

Supermicro

bmcResetType Defines the type of BMC settings reset. Supported reset types are:

Default: Discard all the settings, but preserve user and network settings.

Default

ResetAllWithRootDefaults

All

YAML schema 97

Table 54. iDRAC factory default setting field definitions (continued)

Field Description Supported values Supported vendors

ResetAllWithRootDefaults: Discard all the settings, and reset the default username to root and password to shipping value.

All: Discard all settings and reset to default credentials.

factoryResetBIOS If set to true, resets BIOS attributes to factory default. true or false

factoryResetStora ge

If set to true, securely erases server disks. true or false Dell

Server spec metadata field definitions

The following table describes the server spec metadata fields and their supported values.

Table 55. Server spec metadata field definitions

Field Description Supported values

metadata id: The Common Language Equipment Identifier (CLEI) code. For example:

SNPWBBC7AA

Tags: Define text strings that are used for tagging and grouping network devices based on attributes such as capability, and other defined parameters.

NOTE: The tags field is optional.

For example:

cpu

memory

Node field definitions

The following table contains definitions and supported values for the fields in the node.

Table 56. Node field definitions

Field Description

Name The name of the node. For the Global Controller node, the default node name is bmo-manager-1. For remote worker nodes, the node name is user configurable.

For example:

worker1, worker2, and so forth.

On-boarded site The name of the site created on the node. For the Global Controller node, the default site name is gc. For remote worker nodes, the site name is user configurable.

For example:

austin, miami, and so forth.

"--" indicates no site is created on the node.

Age The length of time since the node object was created.

For example: 10d

Internal-IP The IP address of the node.

98 YAML schema

Telemetry field definitions

This table contains definitions for the fields in the server telemetry and profile telemetry YAML files.

For more information about telemetry, telemetry metric reports, and attributes (fields), see Telemetry streaming basics and Telemetry metric report definitions.

Table 57. Server and profile telemetry field definitions

Field Description Supported values

Rsys Log: Remote syslog implements the basic syslog protocol, and extends it with content-based filtering, rich filtering capabilities, and flexible configuration options.

rsyslogServer1 Remote syslog server 1 address IPv4, IPV6, or FQDN IP address

rsyslogServer1Port Remote syslog server 1 port Port number

rsyslogServer2 Remote syslog server 2 address IPv4, IPV6, or FQDN IP address

rsyslogServer2Port Remote syslog server 2 port Port number

Supported telemetry reports:

AggregationMetrics Contains base metric values for power, temperature, and CUPS (CPU, Memory, IO, System).

Not applicable

CPUMemMetrics Contains CPU Memory metrics

CPURegisters On Intel platform the report represents the MSR registers and on AMD platform the report represents the MCA registers. The CPU Register dump is platform specific.

FCPortStatistics Contains Fibre Channel Port statistics

FCSensor Contains FC temperature reading

FPGASensor Contains Field Programmable Gate Arrays (FPGA) temperature reading.

FanSensor Contains RPM reading

GPUMetrics Conatins Graphics Processing Unit Health metrics

GPUStatistics Contains Graphics Processing Unit Frame Buffer and Graphic Device (GR) memory ECC(Error-correcting code) statistics data.

MemorySensor Contains memory temperature reading

NICSensor Conatins Network Card temperature reading

NICStatistics Contains NIC Port and Partition Statistics

NVMeSMARTData Contains NVMe SMART Health record

PSUMetrics Contains power supply metrics

PowerMetrics Contains power consumption for all CPUs, DIMMs, System Input and System Output.

PowerStatistics Contains system power consumption statistics

Sensor Contains all IPMI reading

SerialLog SerialLog Report (Server serial logs)

StorageDiskSMARTData Contains SSSD SMART information

StorageSensor Contains temperature information for the storage internal drives

SystemUsage Contains system usage in percentage. This report is platform- dependent, and the data may not be available on all platforms.

YAML schema 99

Table 57. Server and profile telemetry field definitions (continued)

Field Description Supported values

ThermalMetrics Contains thermal metrics

ThermalSensor Contains temperature reading

Telemetry report attributes:

metricReportState Enables metric report definition Enabled or disabled

metricReportType Specifies the type of metric report Periodic

onChange

onRequest

reportActions Specifies what occurs when a report is generated as per the metricReportType.

Example:

LogToMetricReportsColle ction

RedfishEvent

reportUpdates Specifies what to do with subsequent metric reports when a metric report exists.

AppendStopsWhenFull

AppendWrapsWhenFull

NewReport

Overwrite

suppressRepeatedMetricValue Suppresses the repeated metric value Enabled or disabled

metricReportHeartbeatInterval Periodically forces a report that contains at least one value for every currently valid metric.

This property is a Redfish duration and should always be greater than or equal to the recurrence Interval.

Example:

PT0H0M0S

recurrenceInterval Specifies a Redfish duration string. This property is only valid for Periodic reports.

Example:

PT0H5M0S

reportTimeSpan Specifies the duration of the report Example:

PT0H5M0S

Switch field definitions

The following sections describe switch fields in YAML files that are required for various operations: Switch operating system field definitions Switch connectivity field definitions SDNController field definitions Cisco switch field definitions Switch port configuration field definitions Switch common field definitions Switch status fields

A sample switch YAML file is available at Sample switch YAML file.

For information about the switch command executing status attribute in the Bare Metal Orchestrator CLI, see Switch command executing status.

100 YAML schema

Switch operating system field definitions

This table contains definitions and supported values for the following fields in the switch YAML file.

Table 58. Switch operating system field definitions

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:

nosmedia

overwriteInstallation Performs an operating system upgrade on a switch. True or False

Switch connectivity field definitions

This table contains definitions and supported values for the following fields in the switch YAML file.

Table 59. Switch connectivity field definitions

Field Description

ONIE

ipaddress IP address of the switch in ONIE mode

username ONIE username

password ONIE password is optional. Set it to None.

NOS

ipaddress IP address of the switch in NOS mode

username NOS username

password NOS password

SDNController field definitions

This table contains definitions and supported values for attributes in the SDNController YAML file.

These attributes are required to onboard a Cisco switch in Bare Metal Orchestrator.

Table 60. SDNController field definitions

Field Description Supported values

name Name which describes the SDNController object. Example:

nso3

ipaddress The NSO IP address. IP address

username The NSO username. NSO username

password The NSO password. NSO password

Cisco switch field definitions

This table contains definitions and supported values for attributes in the switch YAML file.

These attributes are required to onboard a Cisco switch in Bare Metal Orchestrator.

YAML schema 101

Table 61. Cisco switch field definitions

Field Description Supported values

devicename The name of the Cisco switch being onboarded. Example:

cisco-nexus

mgmtipaddress The IP address of the management interface that connects to the NSO instance.

IP address

sdncontroller The name of the sdncontroller instance that is registered with Bare Metal Orchestrator.

Example:

nso3

nedid ID of a Network element driver deployed in an NSO instance to connect to the switch.

Example:

cisco-nx-cli-5.22:cisco-nx- cli-5.22

authgroup Contains credential information that is required to connect to a remote device such as a Cisco switch.

Example:

myauthgroup

Switch port configuration field definitions

This table contains definitions and supported values for attributes in the switchportconfig YAML file.

These attributes are required to configure Layer 2 VLAN, Layer 3 VLAN, and Ethernet interface settings on a Cisco switch.

Table 62. Switch port configuration field definitions

Field Description Supported values

L2VlanList

vlanID Specifies the VLAN ID. Example: 999

shutdown Disables Layer 2 switching of the VLAN on the switch. True or False

L3VlanList

mtu Specifies the largest data packet in maximum transmission unit (MTU) that a network connected device accepts.

Example: 9216

ipaddress VLAN IP address . IP address

redirects Enables redirecting. If the attribute is enabled, it redirects to an interface configured for the switch.

True or False

interfaceConfig

name Name of the Ethernet interface. Example: 2/10

switchport Applies switch port configuration. True or False

mode Specifies the port mode. Example: Trunk

trunkVlan Specifies the VLAN ID for the port when the switch port mode is trunk. Example: 149

accessVlan Specifies the VLAN ID for the port when the switch port mode is access. Example: 109

Switch common field definitions

The following table contains the definition and supported values for some of the common fields in the switch YAML file.

Table 63. Switch field definitions

Field Description Supported values

systemmode Mode in which the switch is onboarded. ONIE

102 YAML schema

Table 63. Switch field definitions (continued)

Field Description Supported values

NOS

NSO

mgmtipaddress IP address that is assigned to the network switch management interface.

IP address

username Username to log in to the network switch management interface. Username

password Password to log in to the network switch management interface. Password

reInitialize Reinitializes a switch on recovery from a failure. True or False

enableRestConf Enables restconf in a switch. True or False

model Model of the switch. PowerSwitch Z9264F-ON

vendor Name of the switch manufacturer. Dell

Switch status fields

The status section in the switch YAML file displays read-only fields. Some of the fields are described below:

Table 64. Switch status fields

Field Description

InitializationCompleted Displays if the switch initialization has been completed.

OnieInventoryCompleted Displays if the ONIE inventory details have been collected.

NosInventoryCompleted Displays if the NOS inventory details have been collected.

Inventorydata Displays inventory details that are collected.

Nosinventorydata Displays the NOS inventory details that are collected for a switch.

Onieinventorydata Displays the ONIE inventory details that are collected for a switch.

Default boot Displays the default boot mode of the switch.

ONIE mode Displays the IP address and credentials of the switch in ONIE mode.

Operatingsystemname Displays the operating system name of the switch.

State Displays the current state of the switch.

Switch command executing status

The command executing status indicates various operations that are performed on a switch in Bare Metal Orchestrator. Use the status to track the progress of a switch at a granular level.

The following table provides information about the switch command executing states.

Table 65. Switch command executing states

Switch command status Description

CollectOnieInventory To collect ONIE inventory details.

CollectNosInventory To collect NOS inventory details.

Initialize To initialize Dell switch settings.

OsInstall To install Dell OS10 operating system on a Dell switch.

OsUpgrade To upgrade Dell OS10 operating system on a Dell switch.

YAML schema 103

Table 65. Switch command executing states (continued)

Switch command status Description

UpdateRestConf To enable or disable restconf service on a switch.

UpdateFirmware To update Firmware on a Dell switch.

InitializeNso To initialize Cisco switch settings.

AddSDNSwitch To onboard a Cisco switch on NSO.

AddSwitchPortConfig To add port configuration details for a Cisco switch.

Media field definitions

The following table contains definitions and supported values for media fields.

Table 66. Media field definitions

Field Description Supported values

osfilename Name of the ISO or BIN file that is uploaded to Bare Metal Orchestrator.

Example:

VMware-VMvisor- Installer-6.7.0.update03-14320 388.x86_64.iso"

type Specifies the type of managed device.

To install an operating system on a server, enter: server. For other managed devices, enter network.

server

switch

network

vendor Optional user-defined name identifying the vendor of the ISO or BIN image.

For ESXi, a generic ISO image vendor is labeled vmware. If it is a Dell customized image, label the vendor as dell.

Examples:

dell

opensuse

redhat

vmware

windriver

osname Specifies the name of the ISO. The operating system name and the ISO file that is referenced in osfilename must match.

esxi

rhel

wr

suse

osversion Optional version number of the operating system. Version must take the form X.Y.Z, where X is the major version, Y is the minor version, and Z is the patch version.

Example: 6.7u3

externalIPAddr Optionally provide the external IP address of the VM that is running Bare Metal Orchestrator, which is the location of the OVA file. 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.

Example: 10.100.1.0

Driver media field definitions

The following table contains definitions and supported values for the driver media fields.

104 YAML schema

Table 67. Driver media field definitions

Field Description

filePath For servers, the path to the device driver .zip file in the web server. The file name must be included.

Supported values:

For example, http:// :81/data/driver/Intel- icen_1.7.3.0-1OEM.670.0.0.8169922-18990249.zip.

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's web server.

Type The driver category.

version The driver version.

User field definitions

The following table details the definitions and supported values for the user profile.

Table 68. User field definitions

Field Description Supported values

name Name of the user. Alphanumeric characters are supported. Example: JohnSmith

email Email address of the user. Example: user@email.com

country Country Name (2 letter code) Example: US

city Locality Name (for example, city) Example: Brooklyn

organization Organization Name (for example, company) Example: Brooklyn Company

orgUnit Organizational Unit Name (for example, section) Example: Technology Division

province State or Province Name (full name) Example: New York

roles User role. NOTE:

This field is required only for creating users with a Global Admin or Global Reader role.

global-admin or global-reader

Firmware media field definitions

The following table contains definitions and supported values for the firmware media fields.

Table 69. Firmware media field definitions

Field Description

vendor The name of the vendor.

model The model name of the server or the switch.

firmwareName The name to identify the firmware.

category The category of the firmware.

Supported values:

BIOS, BMC, Network, CPLD, Chipset. Diagnostics, OSDriverPack, EnterpriseSolutions, FiberChannel, Memory, Power, SASDrive, SASNonRaid, SASRaid, SecureSystemManagement, SerialATA, SolidStateStorage, SystemManagement, DeviceFirmware, IdentityModule, and Other.

version The version of the firmware to be updated to.

YAML schema 105

Table 69. Firmware media field definitions (continued)

Field Description

imagefilename For servers, the path to the firmware image in the web server.

For example:

" iDRAC-with-Lifecycle-Controller_Firmware_7CH5T_WN64_5.00.10.00_A00.EXE"

For switches, the firmware image in the web server. For example, firmware.bin.

externalIPAddr Optional. Provide the external IP address of the VM that is running Bare Metal Orchestrator, which is the location of the OVA. 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.

Tenant field definitions

The following table contains definitions and supported values for the tenant fields.

Table 70. Tenant field definitions

Field Description Supported values

tenantAdmin The name of the user who is a tenant admin. For example: Ryan

requestResource The servers or switches that you want to associate with the given tenant. Bare Metal Orchestrator transfers the listed servers or switches from the default tenant to the given tenant.

For example:

server1

server2

switch1

releaseResource The servers or switches that you want to disassociate from the given tenant.

Bare Metal Orchestrator transfers the servers or switches from the given tenant to the default tenant.

For example:

server1

server2

switch1

reInitialize A value of "true" reinitializes and updates the status of the tenant.

When set to "false", no action is taken.

true or false

Event field definitions

The following table contains definitions and supported values for the event fields.

Table 71. Event field definitions

Field Description Supported values

Http sink attributes

httpSinkUrl The end point URL of http sink connector. For example: http:// httpsink.metalweaver.svc.cluster.local:5556/ events

Kafka attributes

KafkaBrokers The file-based URL of Kafka server. For example: my-cluster-kafka-external-bootstrap.my- kafkaproject.svc.cluster.local:9094"

kafkatopic Name of the Kafka topic. For example: my-topic

106 YAML schema

Table 71. Event field definitions (continued)

Field Description Supported values

async Specify to send events from Kafka Producer to the Kafka Server synchronously or asynchronously.

If the field is set to false, event messages are sent synchronously, which means a new message is sent only after completing the previous message or transaction.

If the field is set to true, event messages are sent asynchronously without any interruption or stoppage of their transmission to the Kafka server.

true or false

Common attributes

unsubscribe Subscribe or unsubscribe the event generated for a resource.

true or false

subscribedEventTypes Specify the type of the event to be generated.

Normal: An event that is just informational and that indicates a state change of a resource.

Warning: An event that indicates a significant problem. For example, if a server fails while on- boarding, a warning event is logged.

Normal or Warning

subscribedObjects Specifies the component for which events are subscribed.

Server

HardwareProfile

Tenant

Site

Stack field definitions

This section provides the stack deployment field definitions and supported values for VMWare TCP, TKG, and Wind River Cloud Platform deployments.

The following table lists the configurable VMWare TCP operating system deployment settings.

Table 72. Stack field definitions for VMWare TCP

Field Description Example supported values

stackType The type of cloud stack to be deployed. VMWare_TCP

stackVersion The version number of the stack to be deployed. 2.0

stackInstallerConfig Top-level field for the stack installer. Not applicable

installerIp IP address of the installer server. 1.2.3.4

installerUserName User name for the installer server.

installerPassword Password for the installer server.

configFile Name of the installer configuration file. InstallerConfig.json

stackConfig Name of the TCP configuration file. TCPConfig.json

stackHostAdditionConfig Name of the add hosts configuration file. AddHosts.json

VlanId Specifies which VLAN the server is on. 20

Domain Specifies which domain the server is on. dellnfv.com

dnsList Specifies which DNS list the server is on. 1.2.3.0

YAML schema 107

Table 72. Stack field definitions for VMWare TCP (continued)

Field Description Example supported values

serverForDeployment Top-level field for the server used to deploy the stack. Not applicable

ip IP address of the server used to deploy the stack. 1.2.3.4

username User name for the server used to deploy the stack.

password Password for the server used to deploy the stack.

address The ESXi host name. esxi10

name The Bare Metal Orchestrator server name. server1

reInitialize Flag that restarts the stack deployment from a failure point.

When set to "false", no action is taken.

true or false

The following table lists the configurable TKG template settings.

Table 73. Stack field definitions for TKG template

Field Description Example supported values

name The name of the TKG template. management-template, shared-service-template, workload-template

clusterType The type of the cluster to be deployed. MANAGEMENT, SHAREDSERVICE, WORKLOAD

description Brief description about the template.

templateJson The name of the TKG template in .json format. The name must match the used for creating the configuration files.

tkg-management- template.json, tkg- sharedservice-template.json, tkg-workload-template.json

The following table lists the configurable TKG cluster deployment settings.

Table 74. Stack field definitions for TKG cluster deployment

Field Description Example supported values

name Unique name of the cluster. management-cluster, shared- service-cluster, workload- cluster

clusterType The type of the cluster to be deployed. MANAGEMENT, SHAREDSERVICE, WORKLOAD

templateName The template that is used to deploy the cluster. management-template, shared-service-template, workload-template

targetDomainName The name of the domain where the stack is deployed. ndc or rdc

clusterPassword The password of the TKG cluster. The cluster password must: 1. not contain any space. 2. contain at least one digit (0-9). 3. contain minimum eight characters and maximum 20

characters. 4. contain at least one lower-case letter (a-z). 5. contain at least one upper-case letter (A-Z). 6. contain at least one special character (@#$%^&+=!*).

108 YAML schema

Table 74. Stack field definitions for TKG cluster deployment (continued)

Field Description Example supported values

endpointIP Unique end point IP address of the cluster. The IP must be a part of the network subnet.

100.100.10.100

managementClusterName The name of the management cluster. Required only if the clusterType is SHAREDSERVICE or WORKLOAD.

management-cluster

The following table lists the configurable Wind River Cloud Platform stack deployment settings.

Table 75. Stack field definitions for Wind River Cloud Platform deployment

Field Description Example supported values

stackType The type of cloud stack to be deployed. Windriver

stackVersion The version number of the stack to be deployed. 21.05

stackInstallerConfig Top-level field for the stack installer. Not applicable

installerIp IP address of each cloud central and sub-cloud edge server. 1.2.3.4

installerUserName User name for the cloud central server. i.e. the controller-0 server.

installerPassword Password for the cloud central server. i.e. the controller-0 server.

configFile Name of the installer configuration file. installer_config.yaml

domainName Specifies which domain the cloud central server is on. centralcloud

stackConfig Name of the Wind River Cloud Platform stack deployment configuration file.

deployment_config.yaml

dnsList Specifies which DNS list the server is on. 1.2.3.0

serverForDeployment Top-level field for the server used to deploy the components of the Central Cloud.

Not applicable

name The Bare Metal Orchestrator server name.

Specify the name, domain, and type for the mandatory controller-0 and controller-1 components.

To add optional worker components, specify the name, domain, and type for each worker you are deploying.

controller-0

controller-1

worker-0

domain Specifies which domain the cloud cluster component is on. For example:

centralcloud

type Specifies the type of cloud cluster component you are deploying on the Central Cloud: controller-0, controller 1-n, or worker 0-n.

controller-0

controller 1

worker 0

reInitialize This must be set to false. Reinitializing the Wind River Cloud Platform stack is not supported.

false

YAML status fields The status section in the server.yaml file displays a number of read-only fields. Some of the fields are described below:

YAML schema 109

Table 76. YAML status fields

Field Description

Processor Displays processor inventory.

Memory Displays memory module inventory.

Storage Displays storage controllers, disks, and volumes inventory.

SDCard Displays SD memory cards inventory.

System Displays the system inventory.

NIC Displays network adapter inventory.

BIOS Displays a short list of the most common BIOS attributes.

CompleteBIOS Displays all possible BIOS attributes.

Firmware Displays firmware inventory.

PCIeDevice Displays PCIeDevice inventory.

Power Displays power supply inventory.

BMC Displays a short list of the most common BMC attributes.

CompleteBMC Displays all possible BMC attributes.

Boot Displays boot order related inventory.

EthernetInterface Displays ethernet interface related inventory.

FirmwareNames Displays the firmware media names.

Metric Displays metric inventory.

Decommission Displays the decommission status.

SerialNumber Displays the serial number of the system.

PartNumber Displays the manufacturer-defined part number for the system.

Model Displays the model number of the system.

AssetTag Displays the asset tag of the system.

Manufacturer Displays the manufacturer details of the system.

PowerState Displays the power state of the server.

Status Displays the server statuscritical, warning, or ready.

State Displays the current state of the server.

UUID Displays the Universal Unique Identifier (UUID) number of the system.

SKU Displays the Stock Keeping Unit (SKU) for the system.

Location Displays the location information of the server.

OSDetails Displays the details of the operating system, including the IP address, hostname, and driver details.

Stack status fields The status section in the displays a number of read-only fields. Some of the fields are described below:

110 YAML schema

Table 77. Stack status fields

Field Description

tkgClusterRes Displays the TKG cluster details. The status field indicates the deployment status of the cluster.

tkgTemplateRes Displays the TKG template details. The value for tkgID is auto-generated upon successful TKG template creation.

YAML schema 111

Tenant profile YAML file sample

Topics:

Sample tenant YAML file

Sample tenant YAML file The following is an example tenant.yaml file.

apiVersion: mw.dell.com/v1 kind: Tenant metadata: name: tenant-sample spec: tenantAdmin: - Ryan requestResource: servers: - server1 - server2 switches: - switch1 releaseResource: servers: - server3 reInitialize: false

B

112 Tenant profile YAML file sample

Switch YAML file sample

Topics:

Sample switch YAML file

Sample switch YAML file Sample switch YAML files for Dell switches.

The following is an example to onboard a switch in ONIE mode:

apiVersion: mw.dell.com/v1 kind: Switch metadata: name: labels: site: spec: vendor: Dell EMC model: onie: ipaddress: mac: username: password:

The following is an example to onboard a switch in NOS mode:

apiVersion: mw.dell.com/v1 kind: Switch metadata: name: labels: site: spec: vendor: Dell EMC model: username: password: mgmtipaddress: mac: mode: nos

C

Switch YAML file sample 113

Server and hardware profile YAML file samples

Topics:

Server and hardware profile YAML file samples Sample server YAML file Sample hardware profile YAML file Sample operating system deployment YAML files - ESXi Sample operating system deployment YAML files - openSUSE Sample operating system deployment YAML files - Red Hat Enterprise Linux Sample operating system YAML files - Wind River Cloud Platform Sample baseline profile YAML file

Server and hardware profile YAML file samples

Sample YAML files in this appendix show the common server and hardware profile objects and attributes. Operating system attributes are shown in separate sample YAML files. For a complete list of the configurable attribute values, see Server and hardware profile field definitions.

The following sample YAML files are provided:

Sample server YAML file Sample hardware profile YAML file Sample operating system deployment YAML files - ESXi Sample operating system deployment YAML files - openSUSE Sample operating system deployment YAML files - Red Hat Enterprise Linux Sample operating system YAML files - Wind River Cloud Platform

For an example DHCP YAML file, see Sample DHCP configuration YAML file.

Sample server YAML file The following is an example .yaml file.

This example YAML file consolidates most of the available configurable attributes into one file and includes the optional profile label. For an example of operating system related attributes that you can set when installing an operating system on a server, see the sample YAML file for the specific operating system.

NOTE: This file is only for reference. You must use the sample files that are provided with Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: Server metadata: name: server-tag labels: site: durham spec: metadata: tags: name: server_tagname cpu: sample_cpu memory: sample_size

D

114 Server and hardware profile YAML file samples

bmcEndPoint: "https://" userName: root password: powerstate: "On" raid: deleteNonMatchingVolumes: true raidVolumes: - name: TestVolume3 raidType: RAID1 minCapacityBytes: 100000000000 numberOfDrives: 2 mediaType: HDD swRaid: "No" boot: bootOrder: - "USB Hard Disk" - "USB CD/DVD" bios: attributes: logicalProc: Enabled procVirtualization: Enabled setBootOrderFqdd1: "*.*.*" setBootOrderFqdd2: "NIC.*.*" setBootOrderFqdd3: "Optical.*.*" setBootOrderFqdd4: "Floppy.*.*" procAdjCacheLine: Enabled procHwPrefetcher: Enabled procSwPrefetcher: Enabled dcuStreamerPrefetcher: Enabled dcuIpPrefetcher: Enabled #subNumaCluster: Enabled upiPrefetch: Enabled #dynamicCoreAllocation: Enabled procX2Apic: Enabled procCores: All memTest: Enabled memOpMode: OptimizerMode procPwrPerf: MaxPerf memFrequency: MaxPerf procTurboMode: Enabled procC1E: Enabled #nodeInterleave: Disabled corrEccSmi: Enabled oppSrefEn: Enabled #monitorMwait: Enabled cpuInterconnectBusLinkPower: Enabled pcieAspmL1: Enabled uncoreFrequency: DynamicUFS energyPerformanceBias: MaxPower proc1TurboCoreNum: All proc2TurboCoreNum: All memRefreshRate: 1x memPatrolScrub: Extended procCStates: Enabled writeDataCrc: Enabled sriovGlobalEnable: Enabled serialPortAddress: Com1 conTermType: Vt100Vt220 extSerialConnector: Serial1 redirAfterBoot: Disabled serialComm: OnConRedirCom1 failSafeBaud : 19200< nic: - networkAdapterId: attributes: virtualizationMode: SRIOV bannerMessageTimeout: 7 setupKey: Broadcom_SetupKeyCtrlB hideSetupPrompt: Disabled adapterErrorRecovery: Enabled maxPfMsixVectors: 256 nicPorts: - id:

Server and hardware profile YAML file samples 115

attributes: forwardErrorCorrection: Disabled portLinkTraining: Disabled legacyBootProto: PXE rDMANICModeOnPort: Enabled msixVectorsPerVf: 128 operationalLnkSpeed: "10Gbps" dCBX: Disabled aNProtocol: Broadcom_ANProtocolIEEEandBAM mediaAutoDetect: Disabled defaultEVBMode: VEB bootOptionROM: Disabled bootStrapType: AutoDetect wakeOnLan: Disabled vLanMode: Disabled bootRetryCnt: NoRetry permitTotalPortShutdown: Disabled

Sample hardware profile YAML file The following is an example .yaml file.

This example YAML file consolidates most of the available configurable attributes into one file and includes the optional profile selector. For an example of operating system related attributes that you can set when installing an operating system on a server, see the sample YAML file for the specific operating system.

NOTE: This file is only for reference. You must use the sample files provided with Bare Metal Orchestrator deployment.

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: name: hardwareprofile-dell labels: site: gc spec: # Add fields here apply: false preview: true server: bios: attributes: logicalProc: Enabled procVirtualization: Enabled setBootOrderFqdd1: "*.*.*" setBootOrderFqdd2: "NIC.*.*" setBootOrderFqdd3: "Optical.*.*" setBootOrderFqdd4: "Floppy.*.*" procAdjCacheLine: Enabled procHwPrefetcher: Enabled procSwPrefetcher: Enabled dcuStreamerPrefetcher: Enabled dcuIpPrefetcher: Enabled #subNumaCluster: Enabled upiPrefetch: Enabled #dynamicCoreAllocation: Enabled procX2Apic: Enabled procCores: All memTest: Enabled memOpMode: OptimizerMode procPwrPerf: MaxPerf memFrequency: MaxPerf procTurboMode: Enabled procC1E: Enabled #nodeInterleave: Enabled corrEccSmi: Enabled oppSrefEn: Enabled #monitorMwait: Enabled cpuInterconnectBusLinkPower: Enabled pcieAspmL1: Enabled

116 Server and hardware profile YAML file samples

uncoreFrequency: DynamicUFS energyPerformanceBias: MaxPower proc1TurboCoreNum: All proc2TurboCoreNum: All memRefreshRate: 1x memPatrolScrub: Extended procCStates: Enabled writeDataCrc: Enabled sriovGlobalEnable: Enabled serialPortAddress: Com1 conTermType: Vt100Vt220 extSerialConnector: Serial1 redirAfterBoot: Disabled serialComm: OnConRedirCom1 failSafeBaud : 19200 nic: - networkAdapterId: attributes: virtualizationMode: SRIOV bannerMessageTimeout: 7 setupKey: Broadcom_SetupKeyCtrlB hideSetupPrompt: Disabled adapterErrorRecovery: Enabled maxPfMsixVectors: 256 nicPorts: - id: attributes: forwardErrorCorrection: Disabled portLinkTraining: Disabled legacyBootProto: PXE rDMANICModeOnPort: Enabled msixVectorsPerVf: 128 operationalLnkSpeed: "10Gbps" dCBX: Disabled aNProtocol: Broadcom_ANProtocolIEEEandBAM mediaAutoDetect: Disabled defaultEVBMode: VEB bootOptionROM: Disabled bootStrapType: AutoDetect wakeOnLan: Disabled vLanMode: Disabled bootRetryCnt: NoRetry permitTotalPortShutdown: Disabled selectors: model: dell

Sample operating system deployment YAML files - ESXi You can deploy the ESXi operating system on a server using a server YAML file or a hardware profile.

The following sample YAML files show the attributes and values for ESXi deployment on Dell PowerEdge R650 and R750 servers.

NOTE:

These files are only for reference. You must use the sample files provided with Bare Metal Orchestrator deployment.

The comments in the YAML file start with a hash character (#) and is followed by a text or the name of the attribute.

You can remove # to un-comment and edit the attribute value.

Replace what appears between italicized, bold chevrons (< >) with user-supplied content. For example:

password:

Sample server YAML file for ESXi deployment

apiVersion: mw.dell.com/v1 kind: Server

Server and hardware profile YAML file samples 117

metadata: name: server1 labels: site: malibu spec: bmcEndPoint: "https://" userName: root password: bios: attributes: procVirtualization: Enabled bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "esxi-media" # set overwriteInstallation to true while editing existing servers to overwrite existing OS and to trigger a fresh installation overwriteInstallation: false operatingsystemconfig: autoConfigureBoss: true osDriver: - icen-media - ibbd-media #installVolumeID: "Disk.Virtual.0:RAID.Slot.2-1" networkingDetails: hostName: esxi-hostname ntpServer: - "127.0.0.1" dnsSearch: - "dell.com" dnsServer: - "127.0.0.1" installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: HBA - type: RAID name: "Virtual Disk 1" configtype: "preseed" configdata: | # Accept the VMware End User License Agreement vmaccepteula

# Set the root password for the DCUI and Tech Support Mode rootpw

# Specifies another installation script to parse %include /tmp/sks.cfg

# Reboot the machine after scripted installation is complete reboot

# Specifies the NW address - obtain the NW settings from DHCP or static, IP address, Gateway, Subnet Mask, # Nameserver, Hostname, VLAN ID and Device MAC address or device name network --bootproto=static --ip=192.168.20.10 --gateway=192.168.20.254 -- netmask=255.255.255.0 --nameserver="192.168.20.250" --device="MAC" -- hostname=esxi1.dev.dell.com --vlanid=10

######################################################################################### ########## # Section below this should not be edited for a successful ESXi installation ######################################################################################### ##########

# Creates an init script that runs only during the first boot. It has no effect on subsequent boots.

118 Server and hardware profile YAML file samples

%firstboot --interpreter=busybox

# Set the hostname - using the input given in the spec.operatingsystemconfig.networkingDetails.hostname OSHOSTNAME={{.OSNetworkingDetails.HostName}} if [[ $OSHOSTNAME != "" ]]; then esxcli system hostname set --host=$OSHOSTNAME fi

# Set NTP setting NTPList={{.NTPServer}} if [[ ${#NTPList[@]} != 0 ]]; then NTPServer="" for ntp in $NTPList do NTPServer="${NTPServer} -s ${ntp}" done esxcli system ntp set -e=0 esxcli system ntp set $NTPServer esxcli system ntp set -e=1 fi

# Set DNS Search Setting DNSList={{.DNSSearch}} if [[ ${#DNSList[@]} != 0 ]]; then for dns in $DNSList do esxcli network ip dns search add -d $dns done

fi # Set DNS Server Setting DNSServerList={{.DNSServer}} if [[ ${#DNSServerList[@]} != 0 ]]; then for server in $DNSServerList do esxcli network ip dns server add -s $server done fi

# Set boot script to echo onto serial device sed -i '$ d' /etc/rc.local.d/local.sh echo 'echo sol_verify_complete > /dev/klog' >> /etc/rc.local.d/local.sh echo 'sleep 5m' >> /etc/rc.local.d/local.sh echo "esxcli network ip interface ipv4 get | awk 'BEGIN {print \"bmo_ip_details_delimiter\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_ip_details_delimiter\" }' >> /dev/klog" >> /etc/rc.local.d/local.sh echo "echo \" webServer outbound tcp dst 81 true true \" > /etc/vmware/firewall/webServer.xml" >> /etc/rc.local.d/local.sh

echo 'localcli network firewall refresh' >> /etc/rc.local.d/local.sh

# install network driver DEVICEDRIVERS={{.DeviceDriver}} if [[ ${#DEVICEDRIVERS[@]} != 0 ]]; then echo "esxcli system maintenanceMode set -e true" >> /etc/rc.local.d/local.sh for DEVICEDRIVER in $DEVICEDRIVERS do echo "wget $DEVICEDRIVER -O /tmp/driver.zip" >> /etc/rc.local.d/local.sh echo "unzip /tmp/driver.zip -d /tmp/ -o" >> /etc/rc.local.d/local.sh echo "rm -f /tmp/driver.zip" >> /etc/rc.local.d/local.sh echo "localcli software vib install -d /tmp/*.zip" >> /etc/rc.local.d/ local.sh echo "rm -f /tmp/*.zip" >> /etc/rc.local.d/local.sh done echo "esxcli system maintenanceMode set -e false" >> /etc/rc.local.d/local.sh fi echo "esxcli software vib list | awk 'BEGIN {print \"bmo_driver_details\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END {}' >> /dev/klog" >> /etc/rc.local.d/local.sh echo "esxcli software vib list --rebooting-image | awk 'BEGIN {} {if (NR>2)

Server and hardware profile YAML file samples 119

printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_driver_details\" }' >> /dev/klog" >> / etc/rc.local.d/local.sh echo "esxcli network ip interface ipv4 get | awk 'BEGIN {print \"bmo_ip_details_delimiter\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_ip_details_delimiter\" }' >> /dev/klog" >> /etc/rc.local.d/local.sh echo 'exit 0' >> /etc/rc.local.d/local.sh # Send vmkernel log messages to the serial port localcli system settings advanced set -o /Misc/LogToSerial -i 1 # Send vmkernel debug log messages to the serial port localcli system settings advanced set -o /Misc/DebugLogToSerial -i 1 # Set rate for COM2 port to 115200 localcli system settings kernel set -s com2_baud -v 115200 # Set name of serial port to use for logging to COM2 localcli system settings advanced set -o /Misc/LogPort -s COM2 # Create a script to run before kickstart configuration is evaluated, this is used to generate files for the kickstart file to include %pre --interpreter=busybox # Retrieving the Device UID for all types of Volumes supported and using it for partitioning and installing ESXi PICKFIRSTVOLUME={{.PickFirstVolume}} SASADDRESS={{.SASAddress}} TARGET={{.Target}} TARGET=`expr $TARGET % 128` SERIALNUMBER={{.SerialNumber}} BOSSDISKTYPE={{.BossDiskType}} DEVICETYPE={{.DeviceType}} DEVICENAME="" if [[ $DEVICETYPE == "nvme" ]]; then nvmeDevices=$(localcli nvme device list | awk '{print $1}') for nvmeDevice in $nvmeDevices do if [[ $(localcli nvme device get -A $nvmeDevice | grep -c -i $SERIALNUMBER) == 1 ]]; then DEVICENAME=$(localcli storage core adapter device list | awk '{ if($1 == "'$nvmeDevice'") print $2}') fi done echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg elif [[ $DEVICETYPE == "raid" ]]; then if [[ $PICKFIRSTVOLUME == "Yes" ]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'") print $3}' | head -1 | tail -1 | awk '{print $1}') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg else DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'" && $6 == "'$TARGET'") print $3}') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi elif [[ $DEVICETYPE == "hba" ]]; then TARGETLIST=$(esxcfg-mpath -L | grep $SASADDRESS | awk '{ print $6 }' | sort -n) for TGT in $TARGETLIST do DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'" && $6 == "'$TGT'") print $3}') DISPLAYNAME=$(esxcfg-mpath -l | grep -E ".*Display Name.*Disk.*$DEVICENAME" | cut -d":" -f2) if [[ -z "$DISPLAYNAME" ]]; then continue else break fi done echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg elif [[ $DEVICETYPE == "usb" ]]; then echo "install --ignoressd --firstdisk=usb --overwritevmfs --novmfsondisk" >> / tmp/sks.cfg

120 Server and hardware profile YAML file samples

elif [[ $DEVICETYPE == "boss" ]]; then if [[$BOSSDISKTYPE == "Virtual"]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($3 ~ "'ATA'" && $3 ~ "'VD'") print $3}' | awk 'NR==1') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi if [[ -z $DEVICENAME ]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($3 ~ "'ATA'") print $3}' | awk 'NR==1') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi elif [[ $DEVICETYPE == "firstdisk" ]]; then echo "install --firstdisk --overwritevmfs --novmfsondisk" >> /tmp/sks.cfg fi

Sample hardware profile YAML file for ESXi deployment

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: name: hwp-os-install labels: site: gc spec: apply: false preview: true selectors: model: dell-R750 # Add fields here server: bios: attributes: procVirtualization: Enabled bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "esxi-media" # set overwriteInstallation to true while editing existing servers to overwrite existing OS and to trigger a fresh installation overwriteInstallation: false operatingsystemconfig: autoConfigureBoss: false networkingDetails: hostName: esxi-hostname ntpServer: - "127.0.0.1" dnsSearch: - "dell.com" dnsServer: - "127.0.0.1" osDriver: - ibbd - icen #installVolumeID: "Disk.Virtual.0:RAID.Slot.2-1" installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: HBA - type: RAID name: "Virtual Disk 1" configtype: "preseed" configdata: | # Accept the VMware End User License Agreement vmaccepteula # Set the root password for the DCUI and Tech Support Mode rootpw

Server and hardware profile YAML file samples 121

# Specifies another installation script to parse %include /tmp/sks.cfg # Reboot the machine after scripted installation is complete reboot # Specifies the NW address - obtain the NW settings from DHCP or static, IP address, Gateway, Subnet Mask, # Nameserver, Hostname, VLAN ID and Device MAC address or device name network --bootproto=dhcp

######################################################################################### ########## # Section below this should not be edited for a successful ESXi installation ######################################################################################### ##########

# Creates an init script that runs only during the first boot. It has no effect on subsequent boots. %firstboot --interpreter=busybox

# Set the hostname - using the input given in the spec.operatingsystemconfig.networkingDetails.hostname OSHOSTNAME={{.OSNetworkingDetails.HostName}} if [[ $OSHOSTNAME != "" ]]; then esxcli system hostname set --host=$OSHOSTNAME fi

# Set NTP setting NTPList={{.NTPServer}} if [[ ${#NTPList[@]} != 0 ]]; then NTPServer="" for ntp in $NTPList do NTPServer="${NTPServer} -s ${ntp}" done esxcli system ntp set -e=0 esxcli system ntp set $NTPServer esxcli system ntp set -e=1 fi # Set DNS Search Setting DNSList={{.DNSSearch}} if [[ ${#DNSList[@]} != 0 ]]; then for dns in $DNSList do esxcli network ip dns search add -d $dns done fi # Set DNS Server Setting DNSServerList={{.DNSServer}} if [[ ${#DNSServerList[@]} != 0 ]]; then for server in $DNSServerList do esxcli network ip dns server add -s $server done fi

# Set boot script to echo onto serial device sed -i '$ d' /etc/rc.local.d/local.sh echo 'echo sol_verify_complete > /dev/klog' >> /etc/rc.local.d/local.sh echo 'sleep 5m' >> /etc/rc.local.d/local.sh echo "esxcli network ip interface ipv4 get | awk 'BEGIN {print \"bmo_ip_details_delimiter\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_ip_details_delimiter\" }' >> /dev/klog" >> /etc/rc.local.d/local.sh echo 'exit 0' >> /etc/rc.local.d/local.sh # install network driver DEVICEDRIVERS={{.DeviceDriver}} if [[ ${#DEVICEDRIVERS[@]} != 0 ]]; then echo "esxcli system maintenanceMode set -e true" >> /etc/rc.local.d/local.sh for DEVICEDRIVER in $DEVICEDRIVERS

122 Server and hardware profile YAML file samples

do echo "wget $DEVICEDRIVER -O /tmp/driver.zip" >> /etc/rc.local.d/local.sh echo "unzip /tmp/driver.zip -d /tmp/ -o" >> /etc/rc.local.d/local.sh echo "rm -f /tmp/driver.zip" >> /etc/rc.local.d/local.sh echo "localcli software vib install -d /tmp/*.zip" >> /etc/rc.local.d/ local.sh echo "rm -f /tmp/*.zip" >> /etc/rc.local.d/local.sh done echo "esxcli system maintenanceMode set -e false" >> /etc/rc.local.d/local.sh fi echo "esxcli software vib list | awk 'BEGIN {print \"bmo_driver_details\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END {}' >> /dev/klog" >> /etc/rc.local.d/local.sh echo "esxcli software vib list --rebooting-image | awk 'BEGIN {} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_driver_details\" }' >> /dev/klog" >> / etc/rc.local.d/local.sh echo "esxcli network ip interface ipv4 get | awk 'BEGIN {print \"bmo_ip_details_delimiter\"} {if (NR>2) printf(\"%s:%s\n\", \$1, \$2)} END { print \"bmo_ip_details_delimiter\" }' >> /dev/klog" >> /etc/rc.local.d/local.sh echo 'exit 0' >> /etc/rc.local.d/local.sh # Send vmkernel log messages to the serial port localcli system settings advanced set -o /Misc/LogToSerial -i 1 # Send vmkernel debug log messages to the serial port localcli system settings advanced set -o /Misc/DebugLogToSerial -i 1 # Set rate for COM2 port to 115200 localcli system settings kernel set -s com2_baud -v 115200 # Set name of serial port to use for logging to COM2 localcli system settings advanced set -o /Misc/LogPort -s COM2 # Create a script to run before kickstart configuration is evaluated, this is used to generate files for the kickstart file to include %pre --interpreter=busybox # Retrieving the Device UID for all types of Volumes supported and using it for partitioning and installing ESXi PICKFIRSTVOLUME={{.PickFirstVolume}} SASADDRESS={{.SASAddress}} TARGET={{.Target}} TARGET=`expr $TARGET % 128` SERIALNUMBER={{.SerialNumber}} BOSSDISKTYPE={{.BossDiskType}} DEVICETYPE={{.DeviceType}} DEVICENAME="" if [[ $DEVICETYPE == "nvme" ]]; then nvmeDevices=$(localcli nvme device list | awk '{print $1}') for nvmeDevice in $nvmeDevices do if [[ $(localcli nvme device get -A $nvmeDevice | grep -c -i $SERIALNUMBER) == 1 ]]; then DEVICENAME=$(localcli storage core adapter device list | awk '{ if($1 == "'$nvmeDevice'") print $2}') fi done

echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg elif [[ $DEVICETYPE == "raid" ]]; then if [[ $PICKFIRSTVOLUME == "Yes" ]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'") print $3}' | head -1 | tail -1 | awk '{print $1}') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg else DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'" && $6 == "'$TARGET'") print $3}') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi elif [[ $DEVICETYPE == "hba" ]]; then TARGETLIST=$(esxcfg-mpath -L | grep $SASADDRESS | awk '{ print $6 }' | sort -n) for TGT in $TARGETLIST do

Server and hardware profile YAML file samples 123

DEVICENAME=$(esxcfg-mpath -L | awk '{ if($11 == "'$SASADDRESS'" && $6 == "'$TGT'") print $3}') DISPLAYNAME=$(esxcfg-mpath -l | grep -E ".*Display Name.*Disk.*$DEVICENAME" | cut -d":" -f2) if [[ -z "$DISPLAYNAME" ]]; then continue else break fi done echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg elif [[ $DEVICETYPE == "usb" ]]; then echo "install --ignoressd --firstdisk=usb --overwritevmfs --novmfsondisk" >> /tmp/sks.cfg elif [[ $DEVICETYPE == "boss" ]]; then if [[$BOSSDISKTYPE == "Virtual"]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($3 ~ "'ATA'" && $3 ~ "'VD'") print $3}' | awk 'NR==1') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi if [[ -z $DEVICENAME ]]; then DEVICENAME=$(esxcfg-mpath -L | awk '{ if($3 ~ "'ATA'") print $3}' | awk 'NR==1') echo "install --disk=$DEVICENAME --overwritevmfs" >> /tmp/sks.cfg fi elif [[ $DEVICETYPE == "firstdisk" ]]; then echo "install --firstdisk --overwritevmfs --novmfsondisk" >> /tmp/sks.cfg fi

Sample operating system deployment YAML files - openSUSE You can deploy the openSUSE operating system on a server using a server YAML file or a hardware profile.

The following sample YAML files show the attributes and values for openSUSE deployment on Dell PowerEdge R650 and R750 servers.

The autoyast configdata contains sections of XML code. Valid XML elements require a start and end tag. PCDATA that you enter between the start and end tags is parsed. Some but not all elements have attributes associated with them.

NOTE:

These files are only for reference. You must use the sample files provided with Bare Metal Orchestrator deployment.

Comments in the YAML file start with a hash character (#) and is followed by a text or the name of the attribute. You

can remove # to un-comment and edit the attribute value.

Comments in the XML sections of the autoyast configdata use the following format:

Replace what appears between italicized, bold chevrons (< >) with user-supplied content. For example:

password:

In the XML sections, chevrons are omitted from user-supplied content fields. For example:

REPLACE_THIS

Sample server YAML file for openSUSE deployment

apiVersion: mw.dell.com/v1 kind: Server metadata: name: opensuse-server1 labels: site: gc spec:

124 Server and hardware profile YAML file samples

bmcEndPoint: "https://" userName: root password: bios: attributes: bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "opensuse15.3" # set overwriteInstallation to true while editing existing servers to overwrite existing OS and to trigger a fresh installation overwriteInstallation: false operatingsystemconfig: autoConfigureBoss: false #installVolumeID: ""

installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: HBA - type: RAID name: "" configtype: "autoyast" configdata: | false false UTC REPLACE_THIS true REPLACE_THIS REPLACE_THIS static REPLACE_THIS REPLACE_THIS autoneg on REPLACE_THIS REPLACE_THIS onboot default REPLACE_THIS REPLACE_THIS sshd true autoyast2-installation autoyast2 openssh vim-data zypper iputils vim bash curl base all /dev/sda true true / max false REPLACE_THIS dell true REPLACE_THIS root

Sample hardware profile YAML file for openSUSE deployment

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: name: hwp-suse-os-install labels: site: gc spec: apply: false preview: true selectors: model: dell-R750 # Add fields here server: bios: attributes: bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "opensuse15.3" # set overwriteInstallation to true while editing existing servers to overwrite existing OS and to trigger a fresh installation overwriteInstallation: false operatingsystemconfig: autoConfigureBoss: true #installVolumeID: "" installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: HBA - type: RAID name: "" configtype: "autoyast" configdata: |

128 Server and hardware profile YAML file samples

false false UTC REPLACE_THIS true REPLACE_THIS REPLACE_THIS static REPLACE_THIS REPLACE_THIS autoneg on REPLACE_THIS REPLACE_THIS onboot default REPLACE_THIS REPLACE_THIS

Server and hardware profile YAML file samples 129

sshd true autoyast2-installation autoyast2 openssh vim-data zypper iputils vim bash curl base all /dev/sda true true / max false REPLACE_THIS dell true REPLACE_THIS root

Server and hardware profile YAML file samples 131

Sample operating system deployment YAML files - Red Hat Enterprise Linux You can deploy the Red Hat Enterprise Linux operating system on a server using a server YAML file or a hardware profile.

The following sample YAML files shows the attributes and values for Red Hat Enterprise Linux deployment on Dell PowerEdge 15th generation servers.

NOTE:

These files are only for reference. You must use the sample files provided with Bare Metal Orchestrator deployment.

The comments in the YAML file start with a hash character (#) and are followed by a text or the name of the attribute.

You can remove # to un-comment and edit the attribute value.

Replace what appears between italicized, bold chevrons (< >) with user-supplied content. For example:

password:

Sample server YAML file for Red Hat Enterprise Linux deployment

apiVersion: mw.dell.com/v1 kind: Server metadata: name: rhel-os labels: site: gc spec: bmcEndPoint: "https://" userName: root password: powerstate: "On" bios: attributes: bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "rhel-media" operatingsystemconfig: autoConfigureBoss: false networkingDetails: hostName: # installVolumeID: "Disk.Virtual.0:RAID.Integrated.1-1" installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: RAID name: "TestRaid0Vol0" - type: HBA configtype: "kickstart" configdata: |

# set language lang en_US # set keyboard layout keyboard us # set timezone timezone America/New_York --isUtc

# set root password, if --iscrypted is not used then clear text can be used

132 Server and hardware profile YAML file samples

rootpw --iscrypted # performs a reboot after installation reboot # runs text based installation instead of gui based text # installation from type cdrom, harddrive, nfs, liveimg, url cdrom

# Initializes any invalid partition tables that are found on disks and destroys all of the contents of disks with invalid partition tables. # This command is required when performing an installation on an IBM Z system with unformatted Direct Access Storage Device (DASD) disks, # otherwise the unformatted disks are not formatted and used during the installation. zerombr # Removes partitions from the system, prior to creation of new partitions. By default, no partitions are removed. clearpart --all --initlabel # Automatically creates partitions: a root (/) partition (1 GB or larger), a swap partition, # and an appropriate /boot partition for the architecture. On large enough drives (50 GB and larger), this also creates a /home partition. autopart # Configures network information for the target system and activates network devices in the installation environment. # The device specified in the first network command is activated automatically. network --device= -- hostname={{.OSNetworkingDetails.HostName}} --bootproto=static -- ip= --netmask= -- gateway= # System authorization information auth --passalgo=sha512 --useshadow # Sets the state of SELinux on the installed system. The default SELinux policy is enforcing. selinux --disable # Specify the firewall configuration for the installed system. firewall --enabled # If skipx is present, X-Server is not configured on the installed system. skipx # Determine whether the Initial Setup application starts the first time the system is booted. # If enabled, the initial-setup package must be installed. firstboot --enable ######################################################################################### ########## # Section below this should not be edited for a successful RHEL installation ######################################################################################### ########## %pre #!/bin/sh touch /tmp/rhel-install SASADDRESS={{.SASAddress}} TARGET={{.Target}} SERIALNUMBER={{.SerialNumber}} DEVICETYPE={{.DeviceType}} DEVICENAME="" OSHOSTNAME={{.OSNetworkingDetails.HostName}} GROUP="$(vgs --noheadings | awk '{print $1}')" # removing volume group if one exists if ! [ -z "$GROUP" ]; then

Server and hardware profile YAML file samples 133

vgremove -f -y $GROUP fi # wipe drives section # clearpart cannot clear existing bios raid configurations. # adding wipefs -a will remove that configuration DISKS="$(lsblk | grep disk | awk '{print $1}')" for DISK in $DISK; do echo "wiping signature from disk: $DISK" wipefs -a /dev/$DISK done case $DEVICETYPE in "nvme") DEVICENAME="$(ls -al /dev/disk/by-id/ | grep $SERIALNUMBER | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "raid") DEVICENAME="$(smartctl --scan | awk '{print $1}' | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "usb") DEVICENAME="$(ls -al /dev/disk/by-id | grep usb | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "hba") PCI="$(lspci | grep -i sas | awk '{print $1}')" DEVICENAME="$(ls -al /sys/block | grep $PCI | head -n 1 | awk '{print $9}' )" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "boss") DEVICENAME="$(ls -al /dev/disk/by-id/ | grep -i ata | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; esac %end %include /tmp/rhel-install %post /usr/bin/sed -i 's/rhgb quiet/console=tty0 console=ttyS1,115200/gI' /etc/default/ grub /usr/sbin/grub2-mkconfig -o /boot/efi/EFI/redhat/grub.cfg cat > /usr/lib/systemd/system/install_complete.service << EOF

hostnamectl set-hostname {{.OSNetworkingDetails.HostName}} [Unit] Description=Install Complete After=systemd-firstboot.target systemd-journald.service [Service]

OSHOSTNAME={{.OSNetworkingDetails.HostName}} Type=oneshot User=root RemainAfterExit=No ExecStart=/usr/bin/sh -c 'echo "sol_verify_complete" > /dev/kmsg' ExecStart=/usr/bin/sh -c 'sleep 5m' ExecStart=/usr/bin/sh -c 'printf "bmo_ip_details_delimiter " >> /dev/kmsg' ExecStart=/usr/bin/sh -c 'ip -4 addr |egrep "en[a-z][0-9]+|eth[0-9]+" | grep "inet" | cut -d " " -f 12 >> /dev/kmsg' ExecStart=/usr/bin/sh -c 'printf ":" >> /dev/kmsg' ExecStart=/usr/bin/sh -c 'hostname -I|cut -d" " -f 1 >> /dev/kmsg' ExecStart=/usr/bin/sh -c 'printf " bmo_ip_details_delimiter" >> /dev/kmsg'

134 Server and hardware profile YAML file samples

ExecStart=/usr/bin/sh -c 'sudo hostnamectl set-hostname $OSHOSTNAME ' ExecStart=/usr/bin/sh -c 'cat $OSHOSTNAME >> /etc/hostname'

EOF /usr/bin/ln -sf /usr/lib/systemd/system/install_complete.service /usr/lib/systemd/ system/default.target.wants/install_complete.service %end %packages @^minimal-environment kexec-tools %end

Sample hardware profile YAML file for Red Hat Enterprise Linux deployment

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: name: hwp-dell labels: site: gc spec: apply: false preview: true selectors: model: dell-R750 # Add fields here server: powerState: "On" bios: attributes: bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: serialRedirectEnable: Enabled rfsIgnoreCertWarning: "Yes" operatingsystemname: "rhel-media" operatingsystemconfig: autoConfigureBoss: true #installVolumeID: "Disk.Virtual.0:RAID.Slot.2-1" installVolumeTypeOrder: - type: BOSS - type: SDCARD - type: NVME - type: RAID name: "NAME_OF_VIRTUAL_DISK" - type: HBA configtype: "kickstart" configdata: |

lang en_US keyboard us timezone America/New_York --isUtc # Set the root password for the DCUI and Tech Support Mode rootpw --iscrypted # Reboot the machine after scripted installation is complete reboot text cdrom

Server and hardware profile YAML file samples 135

zerombr clearpart --all --initlabel network --bootproto=dhcp auth --passalgo=sha512 --useshadow selinux --disable firewall --enabled skipx firstboot --enable %pre #!/bin/sh touch /tmp/rhel-install SASADDRESS={{.SASAddress}} TARGET={{.Target}} SERIALNUMBER={{.SerialNumber}} DEVICETYPE={{.DeviceType}} DEVICENAME="" GROUP="$(vgs --noheadings | awk '{print $1}')" # removing volume group if one exists if ! [ -z "$GROUP" ]; then vgremove -f -y $GROUP fi # wipe drives section # clearpart cannot clear existing bios raid configurations. # adding wipefs -a will remove that configuration DISKS="$(lsblk | grep disk | awk '{print $1}')" for DISK in $DISK; do echo "wiping signature from disk: $DISK" wipefs -a /dev/$DISK done case $DEVICETYPE in "nvme") DEVICENAME="$(ls -al /dev/disk/by-id/ | grep $SERIALNUMBER | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "raid") DEVICENAME="$(smartctl --scan | awk '{print $1}' | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "usb") DEVICENAME="$(ls -al /dev/disk/by-id | grep usb | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "hba") PCI="$(lspci | grep -i sas | awk '{print $1}')" DEVICENAME="$(ls -al /sys/block | grep $PCI | head -n 1 | awk '{print $9}' )" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; "boss") DEVICENAME="$(ls -al /dev/disk/by-id/ | grep -i ata | awk '{print $11}' | cut -c 7- | head -n 1)" echo "ignoredisk --only-use=$DEVICENAME" >> /tmp/rhel-install ;; esac %end %include /tmp/rhel-install %post /usr/bin/sed -i 's/rhgb quiet/console=tty0 console=ttyS1,115200/gI' /etc/default/ grub

/usr/sbin/grub2-mkconfig -o /boot/efi/EFI/redhat/grub.cfg

136 Server and hardware profile YAML file samples

cat > /usr/lib/systemd/system/install_complete.service << EOF

[Unit] Description=Install Complete After=systemd-firstboot.target systemd-journald.service [Service] Type=oneshot User=root RemainAfterExit=No ExecStart=/usr/bin/sh -c 'echo "sol_verify_complete; bmo_ip_details_delimiter TBD bmo_ip_details_delimiter" > /dev/kmsg' EOF /usr/bin/ln -sf /usr/lib/systemd/system/install_complete.service /usr/lib/ systemd/system/default.target.wants/install_complete.service %end %packages @^minimal-environment kexec-tools %end

Sample operating system YAML files - Wind River Cloud Platform You can deploy the Wind River Cloud Platform operating system on a server using a server YAML file.

The following sample YAML file shows the attributes and values for deployment on Dell PowerEdge 15th generation servers.

NOTE:

These files are only for reference. You must use the sample files provided with Bare Metal Orchestrator deployment.

The comments in the YAML file start with a hash character (#) and are followed by a text or the name of the attribute.

You can remove # to un-comment and edit the attribute value.

Replace what appears between italicized, bold chevrons (< >) with user-supplied content. For example:

password:

Sample server YAML file for Wind River Cloud Platform operating system deployment

apiVersion: mw.dell.com/v1 kind: Server metadata: name: wr-controller labels: model: dell site: gc spec: bmcEndPoint: "https://" userName: "root" password: "" powerstate: "On" bios: attributes:

Server and hardware profile YAML file samples 137

bootMode: Uefi serialPortAddress: Com2 bmc: - attributes: rfsIgnoreCertWarning: "Yes" serialRedirectEnable: Enabled operatingsystemname: "wrmedia" operatingsystemconfig: networkingDetails: hostName: "wr-hostname" # installVolumeID: "Disk.Virtual.0:RAID.Slot.2-1" bootMenuOption: "2" minimumDiskSize: 500 // size in GB installVolumeTypeOrder: - type: NVME - type: BOSS - type: RAID name: "NAME_OF_VIRTUAL_DISK" - type: HBA configtype: "kickstart" configdata: | OAM_DEV=enp94s0f0 OAM_VLAN=33 OSHOSTNAME={{.OSNetworkingDetails.HostName}} cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV DEVICE=$OAM_DEV BOOTPROTO=none ONBOOT=yes LINKDELAY=20 EOF cat << EOF > /etc/sysconfig/network-scripts/ifcfg-$OAM_DEV.$OAM_VLAN DEVICE=$OAM_DEV.$OAM_VLAN BOOTPROTO=none IPADDR=192.168.33.10 PREFIX=24 GATEWAY=192.168.33.100 ONBOOT=yes VLAN=yes LINKDELAY=20 HOSTNAME=$OSHOSTNAME EOF cat > /usr/lib/systemd/system/install_complete.service << EOF [Unit] Description=Install Complete After=systemd-firstboot.target systemd-journald.service [Service]

OSHOSTNAME={{.OSNetworkingDetails.HostName}} Type=oneshot User=root RemainAfterExit=No ExecStart=/usr/bin/sh -c 'echo "sol_verify_complete" > /dev/ttyS1'

ExecStart=/usr/bin/sh -c 'sleep 5m' ExecStart=/usr/bin/sh -c 'printf "bmo_ip_details_delimiter " >> /dev/ttyS1' ExecStart=/usr/bin/sh -c 'ip -4 addr |egrep "en[a-z][0-9]+|eth[0-9]+" | grep "inet" | cut -d " " -f 11 >> /dev/ttyS1' ExecStart=/usr/bin/sh -c 'printf ":" >> /dev/ttyS1' ExecStart=/usr/bin/sh -c 'hostname -I|cut -d" " -f 1 >> /dev/ttyS1' ExecStart=/usr/bin/sh -c 'printf " bmo_ip_details_delimiter" >> /dev/ttyS1' ExecStart=/usr/bin/sh -c 'sudo hostnamectl set-hostname $OSHOSTNAME ' ExecStart=/usr/bin/sh -c 'cat $OSHOSTNAME >> /etc/hostname'

138 Server and hardware profile YAML file samples

EOF /usr/bin/ln -sf /usr/lib/systemd/system/install_complete.service /usr/lib/systemd/ system/default.target.wants/install_complete.service

Sample baseline profile YAML file The following is an example .yaml file.

This example YAML file shows the editable attributes that you need to define before you can use it to decommission a server. The profileName selector is used to target servers to be decommissioned. The server must have a matching profileName label configured.

You can edit every field in this YAML file, but you cannot delete fields.

NOTE: This example file is only for reference. Use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: HardwareProfile metadata: finalizers: - baseline-profile name: baseline-profile labels: site: gc namespace: metalweaver spec: apply: false preview: true selectors: #Please update the vendor label value vendor: " " profileName: " " server: decommission: secureEraseDrives: true bmc: - attributes: topologyLLDP: Disabled ipmiLanEnable: Disabled osBmcPassThroughState: Disabled timeZone: CST6CDT vlanEnable: Disabled vlanID: 1 snmpAgentEnable: Enabled snmpDiscoveryPortNumber: 161 snmpAgentCommunityName: public snmpProtocol: All virtualConsolePluginType: eHTML5 serialRedirectEnable: Enabled rfsIgnoreCertWarning: "Yes" bmcUsers: bmcDeleteUsers: - userName: " " bmcCreateUsers: - userName: " " password: " " roleId: "Operator" enabled: True bmcUpdateUsers: - userName: " " password: " " roleId: "Administrator"

Server and hardware profile YAML file samples 139

bios: attributes: procVirtualization: Enabled bootMode: Uefi serialPortAddress: Com2 logicalProc: Enabled setBootOrderFqdd1: "*.*.*" setBootOrderFqdd2: "NIC.*.*" setBootOrderFqdd3: "Optical.*.*" setBootOrderFqdd4: "Floppy.*.*" procAdjCacheLine: Enabled procHwPrefetcher: Enabled procSwPrefetcher: Enabled dcuStreamerPrefetcher: Enabled dcuIpPrefetcher: Enabled subNumaCluster: Disabled upiPrefetch: Enabled dynamicCoreAllocation: Disabled procX2Apic: Enabled procCores: All # can be 1 memTest: Disabled memOpMode: OptimizerMode # can be FaultResilientMode procPwrPerf: SysDbpm memFrequency: MaxPerf procTurboMode: Enabled procC1E: Enabled nodeInterleave: Disabled corrEccSmi: Enabled oppSrefEn: Disabled

monitorMwait: Enabled cpuInterconnectBusLinkPower: Enabled pcieAspmL1: Enabled uncoreFrequency: DynamicUFS energyPerformanceBias: BalancedPerformance proc1TurboCoreNum: All proc2TurboCoreNum: All memRefreshRate: 1x memPatrolScrub: Standard procCStates: Enabled #Can be Autonomous writeDataCrc: Disabled sriovGlobalEnable: Disabled conTermType: Vt100Vt220 extSerialConnector: Serial1 redirAfterBoot: Enabled serialComm: OnConRedirAuto failSafeBaud : "115200"

140 Server and hardware profile YAML file samples

Server and profile telemetry YAML file samples

Topics:

Sample server telemetry YAML file Sample profile telemetry YAML file

Sample server telemetry YAML file The following is an example .yaml file:

NOTE: This file is only for reference. You must use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: ServerTelemetry metadata: name: server3 labels: site: gc spec: rsyslogServer1: 2.3.4.5 rsyslogServer1Port: 42 rsyslogServer2: 3.4.5.6 rsyslogServer2Port: 42 report: AggregationMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S CPUMemMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S CPURegisters: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S

E

Server and profile telemetry YAML file samples 141

CPUSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FCPortStatistics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FCSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FPGASensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FanSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S GPUMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S GPUStatistics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite

142 Server and profile telemetry YAML file samples

suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S MemorySensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NICSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NICStatistics: metricReportState: Disabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NVMeSMARTData: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PSUMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PowerMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PowerStatistics: metricReportState: Disabled metricReportType: Periodic

Server and profile telemetry YAML file samples 143

reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S Sensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S SerialLog: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S StorageDiskSMARTData: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S StorageSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S SystemUsage: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S ThermalMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S

144 Server and profile telemetry YAML file samples

reportTimeSpan: PT0H0M15S ThermalSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S

Sample profile telemetry YAML file The following is an example .yaml file.

NOTE: This file is only for reference. You must use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: profileTelemetry metadata: name: hardwareprofile-1 labels: site: gc spec: server: rsyslogServer1: 2.3.4.5 rsyslogServer1Port: 42 rsyslogServer2: 3.4.5.6 rsyslogServer2Port: 42 report: AggregationMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S CPUMemMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S CPURegisters: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S CPUSensor: metricReportState: Enabled metricReportType: Periodic

Server and profile telemetry YAML file samples 145

reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FCPortStatistics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FCSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FPGASensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S FanSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S GPUMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S GPUStatistics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S

146 Server and profile telemetry YAML file samples

reportTimeSpan: PT0H0M15S MemorySensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NICSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NICStatistics: metricReportState: Disabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S NVMeSMARTData: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PSUMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PowerMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S PowerStatistics: metricReportState: Disabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent

Server and profile telemetry YAML file samples 147

reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S Sensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S SerialLog: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S StorageDiskSMARTData: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S StorageSensor: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S SystemUsage: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S ThermalMetrics: metricReportState: Enabled metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S ThermalSensor: metricReportState: Enabled

148 Server and profile telemetry YAML file samples

metricReportType: Periodic reportActions: - LogToMetricReportsCollection - RedfishEvent reportUpdates: Overwrite suppressRepeatedMetricValue: Disabled metricReportHeartbeatInterval: PT0H0M0S recurrenceInterval: PT0H0M0S reportTimeSpan: PT0H0M15S

Server and profile telemetry YAML file samples 149

Site Configuration YAML Examples

Topics:

Sample DHCP configuration YAML file

Sample DHCP configuration YAML file The following is an example global_site.yaml file that includes DHCP settings for automatic server discovery.

--- apiVersion: mw.dell.com/v1 kind: Site metadata: name: malibu spec: # Add fields here nodeName: type: remote location: malibu autoDiscoveryMode: discoveryViaDhcp: auto dhcpDeployMode: server DhcpConfigData: dhcpSubnet: - defaultLeaseTime: 3000 maxLeaseTime: 6000 netmask: "255.255.255.0" optionBroadcastAddress: "255.255.255.0" optionRouters: "172.16.14.2" optionSubnetMask: "255.255.255.0" subnet: "172.16.14.0" dhcpPool: - allowMembers: - "iDRAC" denyMembers: endRange: "172.16.14.210" startRange: "172.16.14.199" - allowMembers: - "udhcp 1.23.1" denyMembers: endRange: "172.16.14.220" startRange: "172.16.14.211" - allowMembers: - "CPQRIB3" denyMembers: endRange: "172.16.14.230" startRange: "172.16.14.221" - defaultLeaseTime: 3000 maxLeaseTime: 6000 netmask: "255.255.255.0" optionBroadcastAddress: "255.255.255.0" optionRouters: "192.168.14.2" optionSubnetMask: "255.255.255.0" subnet: "192.168.14.0" dhcpPool: - allowMembers: denyMembers: - "iDRAC" - "udhcp 1.23.1" - "CPQRIB3" endRange: "192.168.14.210"

F

150 Site Configuration YAML Examples

startRange: "192.168.14.199" interfaces: "ens192, ens224" vendorClassIdentifier: - iDRAC - udhcp 1.23.1 - CPQRIB3 - onie_vendor:x86_64-dellemc domain: "dell.com" dns: "8.8.8.8, 8.8.4.4" defaultLeaseTime: "3000" maxLeaseTime: "6000" additionalDhcpConfig: "log-facility local7;" metadata: id: MALICFBC city: Malibu state: California address: "5450 Great America Pkwy, Malibu, CA 95054, USA" country: USA latLong: "37.404882, -121.978486"

Site Configuration YAML Examples 151

Stack deployment YAML example

Topics:

Sample VMWare TCP stack deployment YAML file Sample TKG deployment YAML file Sample Wind River Cloud Platform stack deployment YAML file

Sample VMWare TCP stack deployment YAML file The following is an example .yaml file.

NOTE: This file is only for reference. You must use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: Stackdeployer metadata: name: tcp-stack-1 labels: site: spec: stackType: "VMWare_TCP" stackVersion: "2.0" stackInstallerConfig: installerIp: "1.2.3.4" installerUserName: "USERNAME" installerPassword: "REPLACETHIS" configFile: "InstallerConfig.json" stackConfig: "TCPConfig.json" stackHostAdditionConfig: "AddHosts.json" VlanId: "20" Domain: "dellnfv.com" dnsList: - "1.2.3.0" serverForDeployment: - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi10" name: "server1" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi11" name: "server2" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi12" name: "server3" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi13" name: "server4" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi14" name: "server5"

G

152 Stack deployment YAML example

- ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi15" name: "server6" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi16" name: "server7" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi17" name: "server8" reInitialize: false

Sample TKG deployment YAML file The following is an example .yaml file that is used for TKG deployments.

NOTE: This file is only for reference. You must use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: Stackdeployer metadata: name: tcp-stack-1 labels: model: dell site: gc spec: stackType: "VMWare_TCP" stackVersion: "2.0" stackInstallerConfig: - installerIp: "1.2.3.4" installerUserName: "USERNAME" installerPassword: "REPLACETHIS" configFile: "InstallerConfig.json" stackConfig: ["TCPConfig.json"] stackHostAdditionConfig: "AddHosts.json" VlanId: "20" Domain: "dellnfv.com" vmwareRequest: createTKGTemplateList: - name: "management-template" clusterType: "MANAGEMENT" description: "description of template" templateJson: "tkg-management-template.json" - name: "shared-service-template" clusterType: "SHAREDSERVICE" description: "description of template" templateJson: "tkg-sharedservice-template.json" - name: "workload-template" clusterType: "WORKLOAD" description: "description of template" templateJson: "tkg-workload-template.json" createTKGClusterList: - name: "management-cluster" clusterType: "MANAGEMENT" templateName: "management-template" targetDomainName: "DOMAIN-NAME" clusterPassword: "REPLACE-THIS" endpointIP: "1.2.3.10" - name: "shared-service-cluster" clusterType: "SHAREDSERVICE" templateName: "shared-service-template" targetDomainName: "DOMAIN-NAME"

Stack deployment YAML example 153

clusterPassword: "REPLACE-THIS" endpointIP: "1.2.3.11" managementClusterName: "management-cluster" - name: "workload-cluster" clusterType: "WORKLOAD" templateName: "workload-template" targetDomainName: "DOMAIN-NAME" clusterPassword: "REPLACE-THIS" endpointIP: "1.2.3.12" managementClusterName: "management-cluster" deleteTKGClusterList: - "cluster1" - "cluster2" deleteTKGTemplateList: - "template-1" - "template-2" dnsList: - "1.2.3.0" serverForDeployment: - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi10" name: "server1" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi11" name: "server2" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi12" name: "server3" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi13" name: "server4" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi14" name: "server5" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi15" name: "server6" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi16" name: "server7" - ip: "1.2.3.4" username: "root" password: REPLACE_THIS address: "esxi17" name: "server8" reInitialize: false

154 Stack deployment YAML example

Sample Wind River Cloud Platform stack deployment YAML file The following is an example Wind River Cloud Platform stack deployment profile .yaml file.

NOTE: This file is only for reference. You must use the sample files that are provided with the Bare Metal Orchestrator

deployment.

apiVersion: mw.dell.com/v1 kind: Stackdeployer metadata: name: wr-stack-1 labels: site: spec: stackType: "Windriver" stackVersion: "21.05" stackInstallerConfig: installerIp: "1.2.3.4" installerUserName: "USERNAME" installerPassword: "REPLACETHIS" configFile: "installer_config.yaml" domainName : "centralcloud" stackConfig: ["deployment_config.yaml"] dnsList: - "1.2.3.45" serverForDeployment: - name : "controller-0" domain: "centralcloud" type : controller-0 namespace: "metalweaver" - name : "controller-1" domain: "

Manualsnet FAQs

If you want to find out how the 1.3 Dell works, you can view and download the Dell Bare Metal Orchestrator 1.3 Software Command Line Interface Reference Guide on the Manualsnet website.

Yes, we have the Command Line Interface Reference Guide for Dell 1.3 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 Command Line Interface Reference Guide should include all the details that are needed to use a Dell 1.3. Full manuals and user guide PDFs can be downloaded from Manualsnet.com.

The best way to navigate the Dell Bare Metal Orchestrator 1.3 Software Command Line Interface Reference 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.3 Software Command Line Interface Reference 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.3 Software Command Line Interface Reference 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.3 Software Command Line Interface Reference Guide, simply download the document to your computer. Once downloaded, open the PDF file and print the Dell Bare Metal Orchestrator 1.3 Software Command Line Interface Reference Guide as you would any other document. This can usually be achieved by clicking on “File” and then “Print” from the menu bar.