# metalcloud-cli server register

Register a new server in MetalSoft

## Synopsis

Register a new server in MetalSoft.

You can provide the server configuration either via command-line flags or by specifying a configuration source using the --config-source flag. 
The configuration source can be a path to a JSON file or 'pipe' to read from standard input.

If --config-source is not provided, you must specify at least --site-id and --management-address, along with any other relevant server details such as --username, --password, --serial-number, --model, and --vendor.

Flag Dependencies:
  --config-source and --site-id are mutually exclusive
  --site-id and --management-address must be used together when not using --config-source

Required Flags (when not using --config-source):
  --site-id              Site ID where the server is located
  --management-address   IPMI/BMC management IP address

Optional Flags:
  --config-source        Source of server configuration (JSON file path or 'pipe')
  --username            IPMI/BMC username
  --password            IPMI/BMC password
  --serial-number       Server serial number
  --model               Server model
  --vendor              Server vendor

Examples:
  ## Register using command line flags
  metalcloud-cli server register --site-id 1 --management-address 10.0.0.1 --username admin --password secret

  ## Register with additional server details
  metalcloud-cli server register --site-id 1 --management-address 10.0.0.1 --username admin --password secret --serial-number ABC123 --model PowerEdge --vendor Dell

  ## Register using JSON configuration file
  metalcloud-cli server register --config-source ./server.json

  ## Register using piped JSON configuration
  cat server.json | metalcloud-cli server register --config-source pipe


```
metalcloud-cli server register [flags]
```

### Options

```
      --config-source string        Source of the new server configuration. Can be 'pipe' or path to a JSON file.
  -h, --help                        help for register
      --management-address string   Management address
      --model string                Model
      --password string             Password
      --serial-number string        Serial number
      --site-id int                 Site ID
      --username string             Username
      --vendor string               Vendor
```

### Options inherited from parent commands

```
  -k, --api_key string         MetalCloud API key
  -c, --config string          Config file path
  -d, --debug                  Set to enable debug logging
  -e, --endpoint string        MetalCloud API endpoint
  -f, --format string          Output format. Supported values are 'text','csv','md','json','yaml'. (default "text")
  -i, --insecure_skip_verify   Set to allow insecure transport
  -l, --log_file string        Log file path
  -v, --verbosity string       Log level verbosity (default "INFO")
```

### SEE ALSO

* [metalcloud-cli server](/content/configuration/cli/metalcloud-cli_server.md)	 - Server management

#### Auto generated by spf13/cobra on 11-Aug-2025