Bare Metal Orchestrator 2.3 Command Line Interface User’s Guide

• 1

  Revision history

• 1

  Product support
• 2

  Contacting Dell Support

• 1

  Bare Metal Orchestrator overview
• 2

  Bare Metal Orchestrator introduction
• 3

  Bare Metal Orchestrator architecture
  • Bare Metal Orchestrator components
  • Remote serviceability and support architecture
• 4

  Validated hardware components
• 5

  Validated hypervisors and operating systems
• 6

  Validated NIC cards
• 7

  License and firmware format requirements
• 8

  Firewall port requirements
• 9

  Bare Metal Orchestrator infrastructure management features and functions
• 10

  Access and accounts
• 11

  Log in to the command line interface
• 12

  Use the CLI as a remote client
• 13

  Maintenance mode
• 14

  License Manager
  • Manage License

• 1

  Managing users
• 2

  Identity and access management overview
• 3

  Create a user with a user YAML file
• 4

  Update kubeconfig file
• 5

  View users
• 6

  Edit a user
• 7

  Change user password
• 8

  Delete a user
• 9

  Create kubeconfig file on demand
• 10

  View roles
• 11

  Describe roles

• 1

  Managing sites
• 2

  Sites overview
• 3

  Site creation workflow
• 4

  View nodes
• 5

  Create remote sites
• 6

  View sites
• 7

  Edit sites
• 8

  Reinitialize sites
• 9

  Delete sites

• 1

  Multi-tenancy
• 2

  Multi-tenancy overview
• 3

  Create tenants
• 4

  Edit tenants
• 5

  View tenants
• 6

  Describe tenant
• 7

  Reinitialize tenants
• 8

  Delete tenants

• 1

  Discovering devices
• 2

  Managed device discovery overview
• 3

  Default credentials for device discovery
  • Edit default credentials
• 4

  Manual bulk server discovery
• 5

  DHCP configuration and automatic discovery
• 6

  DHCP configuration options
  • Enabling DHCP in a BMC
• 7

  Onboard devices using ipscan
• 8

  Show auto-discovered devices list
• 9

  Delete ipscan settings for a site

• 1

  Managing servers
• 2

  Servers overview
• 3

  Create a server or multiple servers and update configurations
• 4

  Edit the server configuration
• 5

  View servers and server status
• 6

  View server inventory
• 7

  Reinitialize servers
• 8

  Delete servers
• 9

  Decommission servers
• 10

  Decommission disks
• 11

  Edit iDRAC default factory settings
• 12

  Brownfield server overview
• 13

  Onboarding brownfield servers
• 14

  Retrieve OS inventory
• 15

  NIC bonding overview
  • Apply NIC bonding
• 16

  BMC event subscriptions
  • Enable and disable the BMC event subscription service
  • Create BMC event subscriptions
  • View BMC event subscriptions
  • Delete BMC event subscriptions

• 1

  Provisioning hardware
• 2

  Hardware profiles overview
• 3

  Hardware profile targeting
• 4

  Create hardware profiles
• 5

  Preview server configuration status
• 6

  Apply a hardware profile configuration
• 7

  Edit hardware profile configuration
• 8

  View hardware profiles
• 9

  View hardware profile details
• 10

  Delete hardware profiles

• 1

  Managing server configurations
• 2

  Power state configuration - servers
• 3

  BIOS configuration - servers
• 4

  BMC configuration - servers
• 5

  Operating system deployment
  • Operating system deployment workflow - servers
  • Create a media object
  • Create a driver media object
  • Upload images and binary files to the web server
  • Confirm available free space on the node
  • Operating system attributes
  • Verify operating system deployment - servers
  • Delete images and binary files from the web server
  • Operating system installation using PXE boot
• 6

  Operating system upgrade - servers
• 7

  Firmware update
  • Create a firmware media object
• 8

  RAID configuration
  • Delete RAID volumes
  • Convert RAID volume to NON-RAID and NON-RAID volume to RAID
• 9

  Manage server configuration
• 10

  Telemetry enablement
  • Enable telemetry for a server
  • Enable telemetry for servers

• 1

  Managing web server
• 2

  View files on web server
• 3

  Upload files to the web server
• 4

  Download files from web server
• 5

  Delete files from the web server

• 1

  Managing switches
• 2

  Switch overview
• 3

  Create a switch and update configurations
• 4

  Edit switch configuration
• 5

  View switches and switch status
• 6

  View switch inventory
• 7

  Reinitialize a switch
• 8

  Delete a switch
• 9

  Onboard a Cisco switch in Bare Metal Orchestrator
  • Register an NSO instance in Bare Metal Orchestrator

• 1

  Managing switch configurations
• 2

  Operating system deployment - Dell switch
• 3

  Operating system deployment workflow - Dell switch
• 4

  Create a media object - Dell switch
• 5

  Verify operating system deployment - Dell switch
• 6

  License deployment workflow - Dell switch
• 7

  Create a license media object - Dell switch
• 8

  Operating system upgrade - Dell switch
• 9

  Firmware update - Dell switch
• 10

  Create a firmware media object - Dell switch
• 11

  Layer 2 VLAN configuration - Cisco switch
• 12

  Layer 3 VLAN configuration - Cisco switch
• 13

  Ethernet interface configuration - Cisco switch
  • Change the Ethernet interface port mode - Cisco switch
  • Set the IP address for the Ethernet interface - Cisco switch

• 1

  Backing up and restoring clusters
• 2

  Backup and restore overview
• 3

  Back up the cluster
• 4

  Restore from a backup file
• 5

  Schedule cluster backups
• 6

  Change the backup storage location
• 7

  Create backup storage location secret

• 1

  Monitoring Bare Metal Orchestrator
• 2

  Logging
• 3

  Adding a search index to OpenSearch dashboard
• 4

  Export logs
• 5

  Metrics reports
• 6

  Events
  • Event User Interface
  • Set up external kafka
  • Export events
• 7

  Error codes

• 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