Bare Metal Orchestrator 2.3 Command Line Interface Reference Guide

• 1

  Preface

• 1

  Revision history

• 1

  Product support
• 2

  Contacting Dell Support

• 1

  Introduction
• 2

  Bare Metal Orchestrator Command Line Interface introduction
• 3

  Logging in to the command line interface
• 4

  Control command output using pagination
• 5

  Use the CLI as a remote client

• 1

  backup and restore
• 2

  create backup
• 3

  get backup
• 4

  describe backup
• 5

  delete backup
• 6

  create backup schedule
• 7

  get backup schedule
• 8

  describe backup schedule
• 9

  delete backup schedule
• 10

  create backup location
• 11

  get backup location
• 12

  edit backup location
• 13

  delete backup location
• 14

  get restore
• 15

  describe restore
• 16

  delete restore
• 17

  create backup secret
• 18

  delete backup secret

• 1

  events
• 2

  get events

• 1

  firmwaremedia
• 2

  create firmwaremedia
• 3

  get firmwaremedia
• 4

  describe firmwaremedia
• 5

  edit firmwaremedia
• 6

  delete firmwaremedia

• 1

  fs (web server)
• 2

  web server
• 3

  get fs
• 4

  upload fs
• 5

  download fs
• 6

  delete fs

• 1

  hardwareprofile
• 2

  create hardwareprofile
  • apply and preview hardware profile status
• 3

  get hardwareprofile
• 4

  describe hardware profile
• 5

  edit hardware profile
• 6

  delete hardware profile

• 1

  ipscan
• 2

  create ipscan
• 3

  get ipscan
• 4

  delete ipscan

• 1

  license
• 2

  upload license
• 3

  get license
• 4

  validate license
• 5

  activate license
• 6

  download license
• 7

  describe license

• 1

  licensemedia
• 2

  create licensemedia
• 3

  get licensemedia
• 4

  describe licensemedia
• 5

  edit licensemedia
• 6

  delete licensemedia

• 1

  logs
• 2

  get logs

• 1

  media
• 2

  create media
• 3

  get media
• 4

  describe media
• 5

  edit media
• 6

  delete media

• 1

  node
• 2

  get node

• 1

  profiletelemetry
• 2

  create profiletelemetry
• 3

  get profiletelemetry
• 4

  describe profiletelemetry
• 5

  edit profiletelemetry
• 6

  delete profiletelemetry

• 1

  server
• 2

  create server
• 3

  get server
• 4

  describe server
• 5

  edit server
• 6

  delete server
• 7

  edit default iDRAC credentials

• 1

  servertelemetry
• 2

  create servertelemetry
• 3

  get servertelemetry
• 4

  describe servertelemetry
• 5

  edit servertelemetry
• 6

  delete servertelemetry

• 1

  site
• 2

  create site
• 3

  get site
  • Site health status
  • Site deployment states
  • Site operation status
• 4

  describe site
• 5

  edit site
• 6

  delete site

• 1

  switch
• 2

  create switch
• 3

  get switch
• 4

  describe switch
• 5

  edit switch
• 6

  delete switch

• 1

  tenant
• 2

  create tenant
• 3

  get tenant
  • Tenants operation status
• 4

  describe tenant
• 5

  edit tenant
• 6

  delete tenant

• 1

  user and role
• 2

  Users and roles overview
• 3

  create token
• 4

  create user
• 5

  get users
• 6

  edit user
• 7

  delete user
• 8

  get roles
• 9

  describe roles
• 10

  create kubeconfig
• 11

  update kubeconfig

• 1

  version
• 2

  version

• 1

  YAML schema
• 2

  YAML objects and common fields
• 3

  Metadata
• 4

  YAML field specifications
  • Site field definitions
  • DHCP fields
  • Server and hardware profile field definitions
  • Telemetry field definitions
  • Switch field definitions
  • Media field definitions
  • Driver media field definitions
  • User field definitions
  • Firmware media field definitions
  • Tenant field definitions
  • Event field definitions
• 5

  YAML status fields

• 1

  Tenant profile YAML file sample
• 2

  Sample tenant YAML file
• 3

  Certificate rotation workflowtest

• 1

  Switch YAML file sample
• 2

  Sample switch YAML file

• 1

  Server and hardware profile YAML file samples
• 2

  Server and hardware profile YAML file samples
• 3

  Sample server YAML file
• 4

  Sample server YAML file - brownfield onboarding
• 5

  Sample hardware profile YAML file
• 6

  Sample operating system deployment YAML files - ESXi
• 7

  Sample operating system deployment YAML files - openSUSE
• 8

  Sample operating system deployment YAML files - Red Hat Enterprise Linux
• 9

  Sample operating system deployment YAML files - Ubuntu 20.04 LTS
• 10

  Sample operating system YAML files - Wind River Cloud Platform
• 11

  Sample baseline profile YAML file

• 1

  Server and profile telemetry YAML file samples
• 2

  Sample server telemetry YAML file
• 3

  Sample profile telemetry YAML file

• 1

  Site creation and configuration YAML samples
• 2

  Sample global site creation YAML file
• 3

  Sample DHCP configuration YAML file