Skip to content

overview.md

Latest commit

 

History

History
62 lines (47 loc) · 2.02 KB

overview.md

File metadata and controls

62 lines (47 loc) · 2.02 KB
Raw

Usage overview

General syntax

octl <command> <subcommand> [flags]

Main commands

  • iaas - Core IaaS API
  • kube - OKS API
  • storage - OOS API
  • metadata - metadata API
  • profile - Profile management
  • update - Update to the latest version
  • completion - Generate completion shell script

High-level commands vs API calls

High-level commands provide opinionated defaults (like tables) and shortcuts:

  • octl iaas <entity> list
  • octl iaas <entity> describe <id> [<id>]...
  • octl iaas <entity> create
  • octl iaas <entity> update <id> [<id>]... <flags>
  • octl iaas <entity> delete <id> [<id>]...

Direct API calls are also available:

  • octl iaas api <OperationName> <flags>

Output

Output-related flags are documented here: outputs.md

Flag syntax

The flag syntax is:

  • list of values are comma-separated: --Filters.VmStateNames running,stopped

  • boolean flags can be set to false by setting: --TmpEnabled=false

  • lists of embedded objects (e.g. Nics or BlockDeviceMappings in CreateVms) can be configured using indexes:

    • --BlockDeviceMappings.0.Bsu.VolumeType

  • date-time flag values can be set:

    • using the RFC3339 format (e.g. 2026-02-10T14:52:30Z),
    • as a duration offset with a + or - prefix (e.g. +10m, -1h),
    • as a day/month/year offset with a + or - prefix (e.g. +1mo, -1y).

  • date flag values can be set:

    • using the YYYY-MM-DD format,
    • as a day/month/year offset with a + or - prefix (e.g. +1mo, -1y),
    • using shortcuts: beginning-of-month/bom (1st day of the current month), yesterday/y or today/t.

  • maps (tags, labels, annotations, etc.) use the key=value,key=value format

Next