diff --git a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden index 66f9fcd326..71c9e8d12b 100644 --- a/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden +++ b/cmd/scw/testdata/test-all-usage-baremetal-server-create-usage.golden @@ -18,13 +18,13 @@ ARGS: [description] Description associated to the server, max 255 characters [type] Server commercial type [tags.{index}] Tags to associate to the server - [install.os-id] - [install.hostname] - [install.ssh-key-ids.{index}] - [install.user] - [install.password] - [install.service-user] - [install.service-password] + [install.os-id] ID of the OS to install on the server + [install.hostname] Hostname of the server + [install.ssh-key-ids.{index}] SSH key IDs authorized on the server + [install.user] User used for the installation + [install.password] Password used for the installation + [install.service-user] User used for the service to install + [install.service-password] Password used for the service to install [option-ids.{index}] IDs of options to enable on server [organization-id] Organization ID to use. If none is passed the default organization ID will be used [zone=fr-par-1] Zone to target. If none is passed will use default zone from the config (fr-par-1 | fr-par-2 | nl-ams-1) diff --git a/docs/commands/baremetal.md b/docs/commands/baremetal.md index 48cc2c5fc4..f2b0292ee7 100644 --- a/docs/commands/baremetal.md +++ b/docs/commands/baremetal.md @@ -177,13 +177,13 @@ scw baremetal server create [arg=value ...] | description | | Description associated to the server, max 255 characters | | type | | Server commercial type | | tags.{index} | | Tags to associate to the server | -| install.os-id | | | -| install.hostname | | | -| install.ssh-key-ids.{index} | | | -| install.user | | | -| install.password | | | -| install.service-user | | | -| install.service-password | | | +| install.os-id | | ID of the OS to install on the server | +| install.hostname | | Hostname of the server | +| install.ssh-key-ids.{index} | | SSH key IDs authorized on the server | +| install.user | | User used for the installation | +| install.password | | Password used for the installation | +| install.service-user | | User used for the service to install | +| install.service-password | | Password used for the service to install | | option-ids.{index} | | IDs of options to enable on server | | organization-id | | Organization ID to use. If none is passed the default organization ID will be used | | zone | Default: `fr-par-1`
One of: `fr-par-1`, `fr-par-2`, `nl-ams-1` | Zone to target. If none is passed will use default zone from the config | diff --git a/internal/namespaces/baremetal/v1/baremetal_cli.go b/internal/namespaces/baremetal/v1/baremetal_cli.go index 7421f6267d..a5d36e1f58 100644 --- a/internal/namespaces/baremetal/v1/baremetal_cli.go +++ b/internal/namespaces/baremetal/v1/baremetal_cli.go @@ -239,42 +239,49 @@ func baremetalServerCreate() *core.Command { }, { Name: "install.os-id", + Short: `ID of the OS to install on the server`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.hostname", + Short: `Hostname of the server`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.ssh-key-ids.{index}", + Short: `SSH key IDs authorized on the server`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.user", + Short: `User used for the installation`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.password", + Short: `Password used for the installation`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.service-user", + Short: `User used for the service to install`, Required: false, Deprecated: false, Positional: false, }, { Name: "install.service-password", + Short: `Password used for the service to install`, Required: false, Deprecated: false, Positional: false,