Skip to content
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/stackit_beta_server.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,9 @@ stackit beta server [flags]
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
* [stackit beta server backup](./stackit_beta_server_backup.md) - Provides functionality for Server Backup
* [stackit beta server command](./stackit_beta_server_command.md) - Provides functionality for Server Command
* [stackit beta server create](./stackit_beta_server_create.md) - Creates a server
* [stackit beta server delete](./stackit_beta_server_delete.md) - Deletes a server
* [stackit beta server describe](./stackit_beta_server_describe.md) - Shows details of a server
* [stackit beta server list](./stackit_beta_server_list.md) - Lists all servers of a project
* [stackit beta server update](./stackit_beta_server_update.md) - Updates a server

63 changes: 63 additions & 0 deletions docs/stackit_beta_server_create.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
## stackit beta server create

Creates a server

### Synopsis

Creates a server.

```
stackit beta server create [flags]
```

### Examples

```
Create a server with machine type "t1.1", name "server1" and image with id xxx
$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx

Create a server with machine type "t1.1", name "server1", image with id xxx and labels
$ stackit beta server create --machine-type t1.1 --name server1 --image-id xxx --labels key=value,foo=bar

Create a server with machine type "t1.1", name "server1", boot volume source id "xxx", type "image" and size 64GB
$ stackit beta server create --machine-type t1.1 --name server1 --boot-volume-source-id xxx --boot-volume-source-type image --boot-volume-size 64
```

### Options

```
--affinity-group string The affinity group the server is assigned to
--availability-zone string Availability zone
--boot-volume-delete-on-termination Delete the volume during the termination of the server. Defaults to false
--boot-volume-performance-class string Boot volume performance class
--boot-volume-size int Boot volume size (GB). Size is required for the image type boot volumes
--boot-volume-source-id string ID of the source object of boot volume. It can be either 'image-id' or 'volume-id'
--boot-volume-source-type string Type of the source object of boot volume. It can be either 'image' or 'volume'
-h, --help Help for "stackit beta server create"
--image-id string ID of the image. Either image-id or boot volume is required
--keypair-name string The SSH keypair used during the server creation
--labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
--machine-type string Machine type the server shall belong to
-n, --name string Server name
--network-id string ID of the network for the initial networking setup for the server creation
--network-interface-ids strings List of network interface IDs for the initial networking setup for the server creation
--security-groups strings The initial security groups for the server creation
--service-account-emails strings List of the service account mails
--user-data string User data that is provided to the server
--volumes strings The list of volumes attached to the server
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server

41 changes: 41 additions & 0 deletions docs/stackit_beta_server_delete.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
## stackit beta server delete

Deletes a server

### Synopsis

Deletes a server.
If the server is still in use, the deletion will fail


```
stackit beta server delete [flags]
```

### Examples

```
Delete server with ID "xxx"
$ stackit beta server delete xxx
```

### Options

```
-h, --help Help for "stackit beta server delete"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server

46 changes: 46 additions & 0 deletions docs/stackit_beta_server_describe.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
## stackit beta server describe

Shows details of a server

### Synopsis

Shows details of a server.

```
stackit beta server describe [flags]
```

### Examples

```
Show details of a server with ID "xxx"
$ stackit beta server describe xxx

Show detailed information of a server with ID "xxx"
$ stackit beta server describe xxx --details

Show details of a server with ID "xxx" in JSON format
$ stackit beta server describe xxx --output-format json
```

### Options

```
--details Show detailed information about server
-h, --help Help for "stackit beta server describe"
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server

50 changes: 50 additions & 0 deletions docs/stackit_beta_server_list.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## stackit beta server list

Lists all servers of a project

### Synopsis

Lists all servers of a project.

```
stackit beta server list [flags]
```

### Examples

```
Lists all servers
$ stackit beta server list

Lists all servers which contains the label xxx
$ stackit beta server list --label-selector xxx

Lists all servers in JSON format
$ stackit beta server list --output-format json

Lists up to 10 servers
$ stackit beta server list --limit 10
```

### Options

```
-h, --help Help for "stackit beta server list"
--label-selector string Filter by label
--limit int Maximum number of entries to list
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server

44 changes: 44 additions & 0 deletions docs/stackit_beta_server_update.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
## stackit beta server update

Updates a server

### Synopsis

Updates a server.

```
stackit beta server update [flags]
```

### Examples

```
Update server with ID "xxx" with new name "server-1-new"
$ stackit beta server update xxx --name server-1-new

Update server with ID "xxx" with new name "server-1-new" and label(s)
$ stackit beta server update xxx --name server-1-new --labels key=value,foo=bar
```

### Options

```
-h, --help Help for "stackit beta server update"
--labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
-n, --name string Server name
```

### Options inherited from parent commands

```
-y, --assume-yes If set, skips all confirmation prompts
--async If set, runs the command asynchronously
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
-p, --project-id string Project ID
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
```

### SEE ALSO

* [stackit beta server](./stackit_beta_server.md) - Provides functionality for Server

Loading