Skip to content

Commit 328b541

Browse files
marceljkmarceljk
committed
add docs for key-pair commands:
 - create - delete - describe - list - update
1 parent 5bcdbda commit 328b541

7 files changed

+261
-0
lines changed

‎docs/stackit_beta.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ stackit beta [flags]
4040
### SEE ALSO
4141

4242
* [stackit](./stackit.md) - Manage STACKIT resources using the command line
43+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
4344
* [stackit beta network](./stackit_beta_network.md) - Provides functionality for networks
4445
* [stackit beta network-area](./stackit_beta_network-area.md) - Provides functionality for STACKIT Network Area (SNA)
4546
* [stackit beta network-interface](./stackit_beta_network-interface.md) - Provides functionality for network interfaces

‎docs/stackit_beta_key-pair.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
## stackit beta key-pair
2+
3+
Provides functionality for Keypairs
4+
5+
### Synopsis
6+
7+
Provides functionality for Keypairs
8+
9+
```
10+
stackit beta key-pair [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
-h, --help Help for "stackit beta key-pair"
17+
```
18+
19+
### Options inherited from parent commands
20+
21+
```
22+
-y, --assume-yes If set, skips all confirmation prompts
23+
--async If set, runs the command asynchronously
24+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
25+
-p, --project-id string Project ID
26+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
27+
```
28+
29+
### SEE ALSO
30+
31+
* [stackit beta](./stackit_beta.md) - Contains beta STACKIT CLI commands
32+
* [stackit beta key-pair create](./stackit_beta_key-pair_create.md) - Create a keypair
33+
* [stackit beta key-pair delete](./stackit_beta_key-pair_delete.md) - Delete a keypair
34+
* [stackit beta key-pair describe](./stackit_beta_key-pair_describe.md) - Describe a keypair
35+
* [stackit beta key-pair list](./stackit_beta_key-pair_list.md) - Lists all SSH Keypairs
36+
* [stackit beta key-pair update](./stackit_beta_key-pair_update.md) - Update key pair
37+

‎docs/stackit_beta_key-pair_create.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
## stackit beta key-pair create
2+
3+
Create a keypair
4+
5+
### Synopsis
6+
7+
Create a keypair.
8+
9+
```
10+
stackit beta key-pair create [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Create a new key-pair with public-key "ssh-rsa xxx"
17+
$ stackit beta key-pair create --public-key ssh-rsa xxx
18+
19+
Create a new key-pair with public-key from file "/Users/username/.ssh/id_rsa.pub"
20+
$ stackit beta key-pair create --public-key @/Users/username/.ssh/id_rsa.pub
21+
22+
Create a new key-pair with name "KEYPAIR_NAME" and public-key "ssh-rsa yyy"
23+
$ stackit beta key-pair create --name KEYPAIR_NAME --public-key ssh-rsa yyy
24+
25+
Create a new key-pair with public-key "ssh-rsa xxx" and labels "key=value,key1=value1"
26+
$ stackit beta key-pair create --public-key ssh-rsa xxx --labels key=value,key1=value1
27+
```
28+
29+
### Options
30+
31+
```
32+
-h, --help Help for "stackit beta key-pair create"
33+
--labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
34+
--name string Name of the key which will be created
35+
--public-key string Public key which should be add (format: ssh-rsa|sha-ed25519)
36+
```
37+
38+
### Options inherited from parent commands
39+
40+
```
41+
-y, --assume-yes If set, skips all confirmation prompts
42+
--async If set, runs the command asynchronously
43+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
44+
-p, --project-id string Project ID
45+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
46+
```
47+
48+
### SEE ALSO
49+
50+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
51+

‎docs/stackit_beta_key-pair_delete.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
## stackit beta key-pair delete
2+
3+
Delete a keypair
4+
5+
### Synopsis
6+
7+
Delete a keypair.
8+
9+
```
10+
stackit beta key-pair delete [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Delete keypair with name "XXX"
17+
$ stackit beta keypair delete XXX
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta key-pair delete"
24+
```
25+
26+
### Options inherited from parent commands
27+
28+
```
29+
-y, --assume-yes If set, skips all confirmation prompts
30+
--async If set, runs the command asynchronously
31+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
32+
-p, --project-id string Project ID
33+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
34+
```
35+
36+
### SEE ALSO
37+
38+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
39+

‎docs/stackit_beta_key-pair_describe.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
## stackit beta key-pair describe
2+
3+
Describe a keypair
4+
5+
### Synopsis
6+
7+
Describe a keypair.
8+
9+
```
10+
stackit beta key-pair describe [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Get details about a keypair named "KEYPAIR_NAME"
17+
$ stackit beta keypair describe KEYPAIR_NAME
18+
19+
Get only the SSH public key of a keypair with the name "KEYPAIR_NAME"
20+
$ stackit beta keypair describe KEYPAIR_NAME --public-key
21+
```
22+
23+
### Options
24+
25+
```
26+
-h, --help Help for "stackit beta key-pair describe"
27+
--public-key Show only the public key
28+
```
29+
30+
### Options inherited from parent commands
31+
32+
```
33+
-y, --assume-yes If set, skips all confirmation prompts
34+
--async If set, runs the command asynchronously
35+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
36+
-p, --project-id string Project ID
37+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
38+
```
39+
40+
### SEE ALSO
41+
42+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
43+

‎docs/stackit_beta_key-pair_list.md‎

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
## stackit beta key-pair list
2+
3+
Lists all SSH Keypairs
4+
5+
### Synopsis
6+
7+
Lists all SSH Keypairs.
8+
9+
```
10+
stackit beta key-pair list [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Lists all ssh keypairs
17+
$ stackit beta key-pair list
18+
19+
Lists all ssh keypairs which contains the label xxx
20+
$ stackit beta key-pair list --label-selector xxx
21+
22+
Lists all ssh keypairs in JSON format
23+
$ stackit beta key-pair list --output-format json
24+
25+
Lists up to 10 ssh keypairs
26+
$ stackit beta key-pair list --limit 10
27+
```
28+
29+
### Options
30+
31+
```
32+
-h, --help Help for "stackit beta key-pair list"
33+
--label-selector string Filter by label
34+
--limit int Number of SSH keypairs to list
35+
```
36+
37+
### Options inherited from parent commands
38+
39+
```
40+
-y, --assume-yes If set, skips all confirmation prompts
41+
--async If set, runs the command asynchronously
42+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
43+
-p, --project-id string Project ID
44+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
45+
```
46+
47+
### SEE ALSO
48+
49+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
50+

‎docs/stackit_beta_key-pair_update.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## stackit beta key-pair update
2+
3+
Update key pair
4+
5+
### Synopsis
6+
7+
Update key pair.
8+
9+
```
10+
stackit beta key-pair update [flags]
11+
```
12+
13+
### Examples
14+
15+
```
16+
Update the labels of a keypair KEYPAIR_NAME with "key=value,key1=value1"
17+
$ stackit beta key-pair update --labels key=value,key1=value1
18+
```
19+
20+
### Options
21+
22+
```
23+
-h, --help Help for "stackit beta key-pair update"
24+
--labels stringToString Labels are key-value string pairs which can be attached to a server. E.g. '--labels key1=value1,key2=value2,...' (default [])
25+
```
26+
27+
### Options inherited from parent commands
28+
29+
```
30+
-y, --assume-yes If set, skips all confirmation prompts
31+
--async If set, runs the command asynchronously
32+
-o, --output-format string Output format, one of ["json" "pretty" "none" "yaml"]
33+
-p, --project-id string Project ID
34+
--verbosity string Verbosity of the CLI, one of ["debug" "info" "warning" "error"] (default "info")
35+
```
36+
37+
### SEE ALSO
38+
39+
* [stackit beta key-pair](./stackit_beta_key-pair.md) - Provides functionality for Keypairs
40+

0 commit comments

Comments
 (0)