3.26. hammer domain
ドメインを操作します。
Usage:
hammer domain [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a domain
delete, destroy Delete a domain
delete-parameter Delete parameter for a domain
info, show Show a domain
list, index List of domains
set-parameter Create or update parameter for a domain
update Update a domain
Options:
-h, --help Print help3.26.1. hammer domain create
ドメインを作成します。
Usage:
hammer domain create [OPTIONS]
Options:
--description VALUE Full name describing the domain
--dns VALUE Name of DNS proxy to use within this domain
--dns-id VALUE ID of DNS proxy to use within this domain
--location VALUE Set the current location context for the request
--location-id NUMBER Set the current location context for the request
--location-ids LIST REPLACE locations with given ids
--location-title VALUE Set the current location context for the request
--location-titles LIST
--locations LIST
--name VALUE The full DNS domain name
--organization VALUE Set the current organization context for the request
--organization-id NUMBER Set the current organization context for the request
--organization-ids LIST REPLACE organizations with given ids.
--organization-title VALUE Set the current organization context for the request
--organization-titles LIST
--organizations LIST
-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 string3.26.2. hammer domain delete
ドメインを削除します。
Usage:
hammer domain <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
--name VALUE Domain name
--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
-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 string3.26.3. hammer domain delete-parameter
ドメインのパラメーターを削除します。
Usage:
hammer domain delete-parameter [OPTIONS]
Options:
--domain VALUE Domain name
--domain-id NUMBER Numerical ID or domain name
--name VALUE Parameter name
-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 string3.26.4. hammer domain info
ドメインを表示します。
Usage:
hammer domain <info|show> [OPTIONS]
Options:
--fields LIST Show specified fields or predefined field sets only. (See below)
--id VALUE Numerical ID or domain name
--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
--name VALUE Domain name
--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
-h, --help Print help
Predefined field sets:
---------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
---------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
Dns id | x | x |
Subnets/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Parameters/ | x | x |
Created at | x | x |
Updated at | 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 string3.26.5. hammer domain list
ドメインをリスト表示します。
Usage:
hammer domain <list|index> [OPTIONS]
Options:
--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 Scope by locations
--location-title VALUE Set the current location context for the request
--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 Scope by organizations
--organization-title VALUE Set the current organization context for the request
--page NUMBER Page number, starting at 1
--per-page VALUE Number of results per page to return, 'all' to return all results
--search VALUE Filter results
--subnet VALUE Subnet name
--subnet-id VALUE ID of subnet
-h, --help Print help
Predefined field sets:
-------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
-------|-----|---------|-----
Id | x | x | x
Name | x | 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
Search / Order fields:
fullname string
location string
location_id integer
name string
organization string
organization_id integer
params string3.26.6. hammer domain set-parameter
ドメインのパラメーターを作成または更新します。
Usage:
hammer domain set-parameter [OPTIONS]
Options:
--domain VALUE Domain name
--domain-id NUMBER Numerical ID or domain name
--hidden-value BOOLEAN Should the value be hidden
--name VALUE Parameter name
--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 string3.26.7. hammer domain update
ドメインを更新します。
Usage:
hammer domain update [OPTIONS]
Options:
--description VALUE Full name describing the domain
--dns VALUE Name of DNS proxy to use within this domain
--dns-id VALUE ID of DNS proxy to use within this domain
--id VALUE
--location VALUE Set the current location context for the request
--location-id NUMBER Set the current location context for the request
--location-ids LIST REPLACE locations with given ids
--location-title VALUE Set the current location context for the request
--location-titles LIST
--locations LIST
--name VALUE The full DNS domain name
--new-name VALUE The full DNS domain name
--organization VALUE Set the current organization context for the request
--organization-id NUMBER Set the current organization context for the request
--organization-ids LIST REPLACE organizations with given ids.
--organization-title VALUE Set the current organization context for the request
--organization-titles LIST
--organizations LIST
-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