Skip to content

CLI Documentation

Complete documentation for the Open Resource Broker command-line interface.

Quick Reference

Detailed Guides

Key Features

Global Overrides

  • --scheduler - Override scheduler strategy for any command
  • --provider - Override provider instance for any command
  • --format - Control output format (json, yaml, table, list)

Argument Patterns

  • Positional Arguments - orb templates show template-id
  • Flag Arguments - orb templates show --template-id template-id
  • Mixed Usage - Both patterns work for most commands

Multi-Provider Support

  • Default Generation - orb templates generate (all active providers)
  • Specific Provider - orb templates generate --provider aws-prod
  • Specific API - orb templates generate --provider-api EC2Fleet

Common Commands

Setup and Configuration

orb init --scheduler hostfactory --provider aws --region us-east-1
orb config show --format yaml
orb system health --detailed

Template Management

orb templates generate --all-providers
orb templates list --format table
orb templates show aws-basic --format yaml

Machine Operations

orb machines request aws-basic 5
orb machines list --status running --format table
orb requests status req-123

Provider Operations

orb providers list --detailed --format table
orb --provider aws-prod providers health
orb --provider aws-dev templates generate

Getting Started

  1. Initialize Configuration 

    orb init

  2. Generate Templates 

    orb templates generate

  3. List Available Templates 

    orb templates list --format table

  4. Request Machines 

    orb machines request template-id 3

  5. Check Status 

    orb system health

Advanced Usage

Environment-Specific Operations

# Development
orb --provider aws-dev templates generate --provider-api SpotFleet
orb --provider aws-dev machines request spot-template 5

# Production  
orb --provider aws-prod templates generate --provider-api EC2Fleet
orb --provider aws-prod machines request prod-template 10

Scheduler Comparison

# HostFactory format (IBM Symphony compatible)
orb --scheduler hostfactory templates list --format json

# Default format (CLI-friendly)
orb --scheduler default templates list --format table

Batch Operations

# Multiple request status checks
orb requests status req-123 req-456 req-789

# Multiple machine operations
orb machines return i-123 i-456 i-789

See Also