Red Hat Summit Red Hat SummitSupportConsoleDevelopersStart a trialContact

Chapter 58. os

Manipulate operating system

Usage 

# hammer os [OPTIONS] SUBCOMMAND [ARG] ...
Copy to Clipboard Toggle word wrap

Options

  • -h, --help – Print help

58.1. os add-architecture
Copy link

Associate an architecture

Usage 

# hammer os add-architecture [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER
  • --id VALUE
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.2. os add-provisioning-template
Copy link

Associate provisioning templates

Usage 

# hammer os add-provisioning-template [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be associated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.3. os add-ptable
Copy link

Associate a partition table

Usage 

# hammer os add-ptable [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.4. os create
Copy link

Create an operating system

Usage 

# hammer os create [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --architecture-ids LIST – IDs of associated architectures
  • --architectures LIST
  • --description VALUE
  • --family VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --major VALUE
  • --media LIST
  • --medium-ids LIST – IDs of associated media
  • --minor VALUE
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --os-parameters-attributes SCHEMA Array of parameters
  • --partition-table-ids LIST – IDs of associated partition tables
  • --partition-tables LIST
  • --password-hash ENUM – Root password hash function to use Possible value(s): SHA512, SHA256, Base64, Base64-Windows, MD5
  • --provisioning-template-ids LIST IDs of associated provisioning templates
  • --provisioning-templates LIST
  • --release-name VALUE
  • -h, --help – Print help

Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "

58.5. os delete
Copy link

Delete an operating system

Usage 

# hammer os <delete|destroy> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.6. os delete-default-template
Copy link

Usage 

# hammer os delete-default-template [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE – Operatingsystem id
  • --type VALUE – Type of the provisioning template
  • -h, --help – Print help

58.7. os delete-parameter
Copy link

Delete parameter for an operating system

Usage 

# hammer os delete-parameter [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --name VALUE – Parameter name
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • -h, --help – Print help

58.8. os info
Copy link

Show an operating system

Usage 

# hammer os <info|show> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --show-hidden-parameters BOOLEAN Display hidden parameter values
  • --title VALUE – Operating system title
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Release name

x

x

 

Family

x

x

 

Name

x

x

 

Major version

x

x

 

Minor version

x

x

 

Partition tables/

x

x

 

Default templates/

x

x

 

Architectures/

x

x

 

Installation media/

x

x

 

Templates/

x

x

 

Parameters/

x

x

 

58.9. os list
Copy link

List all operating systems

Usage 

# hammer os <list|index> [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --architecture VALUE – Architecture name
  • --architecture-id VALUE – ID of architecture
  • --fields LIST – Show specified fields or predefined field sets only. (See below)
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --medium VALUE – Medium name
  • --medium-id VALUE – ID of medium
  • --order VALUE – Sort and order by a searchable field, e.g. <field> DESC
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --os-parameters-attributes SCHEMA Array of parameters
  • --page NUMBER – Page number, starting at 1
  • --partition-table VALUE – Partition table name
  • --partition-table-id VALUE – ID of partition table
  • --per-page VALUE – Number of results per page to return, all to return all results
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id VALUE ID of template
  • --search VALUE – Filter results
  • -h, --help – Print help

Predefined field sets

Expand
FIELDSALLDEFAULTTHIN

Id

x

x

x

Title

x

x

x

Release name

x

x

 

Family

x

x

 

Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "

Search and order fields

  • architecture – string
  • description – string
  • family – string
  • id – integer
  • major – string
  • medium – string
  • minor – string
  • name – string
  • params – string
  • template – string
  • title – string

58.10. os remove-architecture
Copy link

Disassociate an architecture

Usage 

# hammer os remove-architecture [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --architecture VALUE – Architecture name
  • --architecture-id NUMBER
  • --id VALUE
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.11. os remove-provisioning-template
Copy link

Disassociate provisioning templates

Usage 

# hammer os remove-provisioning-template [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --provisioning-template VALUE – Name to search by
  • --provisioning-template-id NUMBER
  • --provisioning-template-ids LIST – List of provisioning template ids
  • --provisioning-template-search VALUE Provisioning template name regex to search, all matching templates will be disassociated
  • --provisioning-templates LIST – List of provisioning template names
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.12. os remove-ptable
Copy link

Disassociate a partition table

Usage 

# hammer os remove-ptable [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE
  • --partition-table VALUE – Partition table name
  • --partition-table-id NUMBER
  • --title VALUE – Operating system title
  • -h, --help – Print help

58.13. os set-default-template
Copy link

Usage 

# hammer os set-default-template [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --id VALUE – Operatingsystem id
  • --provisioning-template-id VALUE Provisioning template id to be set
  • -h, --help – Print help

58.14. os set-parameter
Copy link

Create or update parameter for an operating system

Usage 

# hammer os set-parameter [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --hidden-value BOOLEAN – Should the value be hidden
  • --name VALUE – Parameter name
  • --operatingsystem VALUE – Operating system title
  • --operatingsystem-id NUMBER
  • --parameter-type ENUM – Type of the parameter Possible value(s): string, boolean, integer, real, array, hash, yaml, json Default: "string"
  • --value VALUE – Parameter value
  • -h, --help – Print help

58.15. os update
Copy link

Update an operating system

Usage 

# hammer os update [OPTIONS]
Copy to Clipboard Toggle word wrap

Options

  • --architecture-ids LIST – IDs of associated architectures
  • --architectures LIST
  • --description VALUE
  • --family VALUE
  • --id VALUE
  • --location VALUE – Set the current location context for the request
  • --location-id NUMBER – Set the current location context for the request
  • --location-title VALUE – Set the current location context for the request
  • --major VALUE
  • --media LIST
  • --medium-ids LIST – IDs of associated media
  • --minor VALUE
  • --name VALUE
  • --organization VALUE – Set the current organization context for the request
  • --organization-id NUMBER – Set the current organization context for the request
  • --organization-title VALUE – Set the current organization context for the request
  • --os-parameters-attributes SCHEMA Array of parameters
  • --partition-table-ids LIST – IDs of associated partition tables
  • --partition-tables LIST
  • --password-hash ENUM – Root password hash function to use Possible value(s): SHA512, SHA256, Base64, Base64-Windows, MD5
  • --provisioning-template-ids LIST IDs of associated provisioning templates
  • --provisioning-templates LIST
  • --release-name VALUE
  • --title VALUE – Operating system title
  • -h, --help – Print help

Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):

  • --os-parameters-attributes "name=<string>,value=<string>, …​ "
Back to top
Red Hat logoGithubredditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust. Explore our recent updates.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

Theme

© 2025 Red Hat