2.79. hammer subnet
サブネットを操作します。
Usage:
hammer subnet [OPTIONS] SUBCOMMAND [ARG] ...
Parameters:
SUBCOMMAND Subcommand
[ARG] ... Subcommand arguments
Subcommands:
create Create a subnet
delete, destroy Delete a subnet
delete-parameter Delete parameter for a subnet
info, show Show a subnet
list, index List of subnets
set-parameter Create or update parameter for a subnet
update Update a subnet
Options:
-h, --help Print help2.79.1. hammer subnet create
サブネットを作成します。
Usage:
hammer subnet create [OPTIONS]
Options:
--bmc-id BMC_ID BMC Capsule ID to use within this subnet
--boot-mode BOOT_MODE Default boot mode for interfaces assigned to this subnet.
Possible value(s): 'Static', 'DHCP'
--description DESCRIPTION Subnet description
--dhcp DHCP_NAME DHCP Proxy to use within this subnet
--dhcp-id DHCP_ID DHCP Capsule ID to use within this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts
--dns DNS_NAME DNS Proxy to use within this subnet
--dns-id DNS_ID DNS Capsule ID to use within this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet is part
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--externalipam-group EXTERNALIPAM_GROUP External IPAM group - only relevant when IPAM is set to external
--externalipam-id EXTERNALIPAM_ID External IPAM Capsule ID to use within this subnet
--from FROM Starting IP Address for IP auto suggestion
--gateway GATEWAY Subnet gateway
--httpboot-id HTTPBOOT_ID HTTPBoot Capsule ID to use within this subnet
--ipam IPAM IP Address auto suggestion mode for this subnet.
Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--mask MASK Netmask for this subnet
--mtu MTU MTU for this subnet
--name NAME Subnet name
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or IPv6, defaults to IPv4
Possible value(s): 'IPv4', 'IPv6'
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--prefix PREFIX Network prefix in CIDR notation (e.g. 64) for this subnet
--remote-execution-proxy-ids REMOTE_EXECUTION_PROXY_IDS List of Capsule IDs to be used for remote execution
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--template-id TEMPLATE_ID Template HTTP(S) Capsule ID to use within this subnet
--tftp TFTP_NAME TFTP Proxy to use within this subnet
--tftp-id TFTP_ID TFTP Capsule ID to use within this subnet
--to TO Ending IP Address for IP auto suggestion
--vlanid VLANID VLAN ID for this subnet
-h, --help Print help2.79.2. hammer subnet delete
サブネットを削除します。
Usage:
hammer subnet <delete|destroy> [OPTIONS]
Options:
--id ID Subnet numeric identifier
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
-h, --help Print help2.79.3. hammer subnet delete-parameter
サブネットのパラメーターを削除します。
Usage:
hammer subnet delete-parameter [OPTIONS]
Options:
--name NAME Parameter name
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
-h, --help Print help2.79.4. hammer subnet info
サブネットを表示します。
Usage:
hammer subnet <info|show> [OPTIONS]
Options:
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--id ID
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-title LOCATION_TITLE Set the current location context for the request
--name NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--show-hidden-parameters SHOW_HIDDEN_PARAMETERS Display hidden parameter values
One of true/false, yes/no, 1/0.
-h, --help Print help
Predefined field sets:
------------------------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
------------------------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Description | x | x |
Protocol | x | x |
Priority | x | x |
Network addr | x | x |
Network prefix | x | x |
Network mask | x | x |
Gateway addr | x | x |
Primary dns | x | x |
Secondary dns | x | x |
Smart proxies/dns | x | x |
Smart proxies/tftp | x | x |
Smart proxies/dhcp | x | x |
Remote execution proxies/id | x | x |
Remote execution proxies/name | x | x |
Ipam | x | x |
Start of ip range | x | x |
End of ip range | x | x |
Vlan id | x | x |
Mtu | x | x |
Boot mode | x | x |
Domains/ | x | x |
Locations/ | x | x |
Organizations/ | x | x |
Parameters/ | x | x |
------------------------------|-----|---------|-----2.79.5. hammer subnet list
サブネットの一覧を表示します。
Usage:
hammer subnet <list|index> [OPTIONS]
Options:
--domain DOMAIN_NAME Domain name
--domain-id DOMAIN_ID ID of domain
--fields FIELDS Show specified fields or predefined field sets only. (See below)
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Scope by locations
--location-title LOCATION_TITLE Set the current location context for the request
--order ORDER Sort field and order, eg. ‘id DESC’
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Scope by organizations
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--page PAGE Page number, starting at 1
--per-page PER_PAGE Number of results per page to return, 'all' to return all results
--search SEARCH Filter results
-h, --help Print help
Predefined field sets:
----------------|-----|---------|-----
FIELDS | ALL | DEFAULT | THIN
----------------|-----|---------|-----
Id | x | x | x
Name | x | x | x
Network addr | x | x |
Network prefix | x | x |
Network mask | x | x |
Vlan id | x | x |
Boot mode | x | x |
Gateway address | x | x |
----------------|-----|---------|-----
Search / Order fields:
boot_mode string
dns_primary string
dns_secondary string
domain string
gateway string
ipam string
location string
location_id integer
mask string
mtu integer
name text
network string
nic_delay integer
organization string
organization_id integer
params string
type string
vlanid integer2.79.6. hammer subnet set-parameter
サブネットのパラメーターを作成または更新します。
Usage:
hammer subnet set-parameter [OPTIONS]
Options:
--hidden-value HIDDEN_VALUE Should the value be hidden
One of true/false, yes/no, 1/0.
--name NAME Parameter name
--parameter-type PARAMETER_TYPE Type of the parameter
Possible value(s): 'string', 'boolean', 'integer', 'real', 'array', 'hash', 'yaml', 'json'
Default: "string"
--subnet SUBNET_NAME Subnet name
--subnet-id SUBNET_ID
--value VALUE Parameter value
-h, --help Print help2.79.7. hammer subnet update
サブネットを更新します。
Usage:
hammer subnet update [OPTIONS]
Options:
--bmc-id BMC_ID BMC Capsule ID to use within this subnet
--boot-mode BOOT_MODE Default boot mode for interfaces assigned to this subnet.
Possible value(s): 'Static', 'DHCP'
--description DESCRIPTION Subnet description
--dhcp DHCP_NAME DHCP Proxy to use within this subnet
--dhcp-id DHCP_ID DHCP Capsule ID to use within this subnet
--discovery-id DISCOVERY_ID ID of Discovery Capsule to use within this subnet for managing connection to discovered hosts
--dns DNS_NAME DNS Proxy to use within this subnet
--dns-id DNS_ID DNS Capsule ID to use within this subnet
--dns-primary DNS_PRIMARY Primary DNS for this subnet
--dns-secondary DNS_SECONDARY Secondary DNS for this subnet
--domain-ids DOMAIN_IDS Domains in which this subnet is part
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--domains DOMAIN_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--externalipam-group EXTERNALIPAM_GROUP External IPAM group - only relevant when IPAM is set to external
--externalipam-id EXTERNALIPAM_ID External IPAM Capsule ID to use within this subnet
--from FROM Starting IP Address for IP auto suggestion
--gateway GATEWAY Subnet gateway
--httpboot-id HTTPBOOT_ID HTTPBoot Capsule ID to use within this subnet
--id ID Subnet numeric identifier
--ipam IPAM IP Address auto suggestion mode for this subnet.
Possible value(s): 'DHCP', 'Internal DB', 'Random DB', 'EUI-64', 'External IPAM', 'None'
--location LOCATION_NAME Set the current location context for the request
--location-id LOCATION_ID Set the current location context for the request
--location-ids LOCATION_IDS REPLACE locations with given ids
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--location-title LOCATION_TITLE Set the current location context for the request
--location-titles LOCATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--locations LOCATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--mask MASK Netmask for this subnet
--mtu MTU MTU for this subnet
--name NAME Subnet name
--network NETWORK Subnet network
--network-type NETWORK_TYPE Type or protocol, IPv4 or IPv6, defaults to IPv4
Possible value(s): 'IPv4', 'IPv6'
--new-name NEW_NAME Subnet name
--organization ORGANIZATION_NAME Set the current organization context for the request
--organization-id ORGANIZATION_ID Set the current organization context for the request
--organization-ids ORGANIZATION_IDS REPLACE organizations with given ids.
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organization-title ORGANIZATION_TITLE Set the current organization context for the request
--organization-titles ORGANIZATION_TITLES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--organizations ORGANIZATION_NAMES Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--prefix PREFIX Network prefix in CIDR notation (e.g. 64) for this subnet
--remote-execution-proxy-ids REMOTE_EXECUTION_PROXY_IDS List of Capsule IDs to be used for remote execution
Comma separated list of values. Values containing comma should be quoted or escaped with backslash.
JSON is acceptable and preferred way for complex parameters
--template-id TEMPLATE_ID Template HTTP(S) Capsule ID to use within this subnet
--tftp TFTP_NAME TFTP Proxy to use within this subnet
--tftp-id TFTP_ID TFTP Capsule ID to use within this subnet
--to TO Ending IP Address for IP auto suggestion
--vlanid VLANID VLAN ID for this subnet
-h, --help Print help