2.50. Hammer os
操作操作系统
Usage:
hammer os [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
add-architecture Associate an architecture
add-provisioning-template Associate provisioning templates
add-ptable Associate a partition table
create Create an operating system
delete, destroy Delete an operating system
delete-default-template
delete-parameter Delete parameter for an operating system
info, show Show an operating system
list, index List all operating systems
remove-architecture Disassociate an architecture
remove-provisioning-template Disassociate provisioning templates
remove-ptable Disassociate a partition table
set-default-template
set-parameter Create or update parameter for an operating system
update Update an operating system
Options:
-h, --help Print help2.50.1. Hammer os add-architecture
关联构架
Usage:
hammer os add-architecture [OPTIONS]
Options:
--architecture VALUE Architecture name
--architecture-id NUMBER
--id VALUE
--title VALUE Operating system title
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.2. Hammer os add-provisioning-template
关联自定义模板
Usage:
hammer os add-provisioning-template [OPTIONS]
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
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.3. Hammer os add-ptable
关联分区表
Usage:
hammer os add-ptable [OPTIONS]
Options:
--id VALUE
--partition-table VALUE Partition table name
--partition-table-id NUMBER
--title VALUE Operating system title
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.4. Hammer os create
创建操作系统
Usage:
hammer os create [OPTIONS]
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): 'SHA256', 'SHA512', 'Base64', 'Base64-Windows', 'MD5'
--provisioning-template-ids LIST IDs of associated provisioning templates
--provisioning-templates LIST
--release-name VALUE
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string
Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):
--os-parameters-attributes "name=<string>\,value=<string>, ... "2.50.5. Hammer os delete
删除操作系统
Usage:
hammer os <delete|destroy> [OPTIONS]
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
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.6. Hammer os delete-default-template
Usage:
hammer os delete-default-template [OPTIONS]
Options:
--id VALUE Operatingsystem id
--type VALUE Type of the provisioning template
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.7. Hammer os delete-parameter
删除操作系统的参数
Usage:
hammer os delete-parameter [OPTIONS]
Options:
--name VALUE Parameter name
--operatingsystem VALUE Operating system title
--operatingsystem-id NUMBER
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.8. Hammer os info
显示操作系统
Usage:
hammer os <info|show> [OPTIONS]
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:
--------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
--------------------|-----|---------|-----
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 |
--------------------|-----|---------|-----
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.9. Hammer os list
列出所有操作系统
Usage:
hammer os <list|index> [OPTIONS]
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:
-------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------------|-----|---------|-----
Id | x | x | x
Title | x | x | x
Release name | x | x |
Family | x | x |
-------------|-----|---------|-----
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string
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 / Order fields:
architecture string
description string
family string
major string
medium string
minor string
name string
params string
template string
title string2.50.10. Hammer os remove-architecture
解除架构关联
Usage:
hammer os remove-architecture [OPTIONS]
Options:
--architecture VALUE Architecture name
--architecture-id NUMBER
--id VALUE
--title VALUE Operating system title
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.11. Hammer os remove-provisioning-template
解除关联自定义模板
Usage:
hammer os remove-provisioning-template [OPTIONS]
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
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.12. Hammer os remove-ptable
解除分区表的关联
Usage:
hammer os remove-ptable [OPTIONS]
Options:
--id VALUE
--partition-table VALUE Partition table name
--partition-table-id NUMBER
--title VALUE Operating system title
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.13. Hammer os set-default-template
Usage:
hammer os set-default-template [OPTIONS]
Options:
--id VALUE Operatingsystem id
--provisioning-template-id VALUE Provisioning template id to be set
-h, --help Print help
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.14. Hammer os set-parameter
为操作系统创建或更新参数
Usage:
hammer os set-parameter [OPTIONS]
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
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string2.50.15. Hammer os update
更新操作系统
Usage:
hammer os update [OPTIONS]
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): 'SHA256', 'SHA512', '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
Option details:
Here you can find option types and the value an option can accept:
BOOLEAN One of true/false, yes/no, 1/0
DATETIME Date and time in YYYY-MM-DD HH:MM:SS or ISO 8601 format
ENUM Possible values are described in the option's description
FILE Path to a file
KEY_VALUE_LIST Comma-separated list of key=value.
JSON is acceptable and preferred way for such parameters
LIST Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for such parameters
MULTIENUM Any combination of possible values described in the option's description
NUMBER Numeric value. Integer
SCHEMA Comma separated list of values defined by a schema.
JSON is acceptable and preferred way for such parameters
VALUE Value described in the option's description. Mostly simple string
Following parameters accept format defined by its schema (bold are required; <> contains acceptable type; [] contains acceptable value):
--os-parameters-attributes "name=<string>\,value=<string>, ... "