Skip to content

Commit 9730702

Browse files
committed
update docs to cloudcli-server v0.1.6
1 parent e96eb1d commit 9730702

28 files changed

Lines changed: 224 additions & 29 deletions

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,10 +33,12 @@ cloudcli --help
3333
#### Server management
3434

3535
* [cloudcli server attach](docs/cloudcli_server_attach.md) - Connect to the server via SSH
36+
* [cloudcli server clone](docs/cloudcli_server_clone.md) - Clone a server
3637
* [cloudcli server configure](docs/cloudcli_server_configure.md) - Change server configuration
3738
* [cloudcli server create](docs/cloudcli_server_create.md) - Create a server
3839
* [cloudcli server description](docs/cloudcli_server_description.md) - Get or set server description
3940
* [cloudcli server disk](docs/cloudcli_server_disk.md) - List/manage server disks
41+
* [cloudcli server history](docs/cloudcli_server_history.md) - List server actions history
4042
* [cloudcli server info](docs/cloudcli_server_info.md) - Get server overview/information
4143
* [cloudcli server list](docs/cloudcli_server_list.md) - List servers
4244
* [cloudcli server network](docs/cloudcli_server_network.md) - List/manage server networks
@@ -45,8 +47,10 @@ cloudcli --help
4547
* [cloudcli server poweroff](docs/cloudcli_server_poweroff.md) - Power Off server/s
4648
* [cloudcli server poweron](docs/cloudcli_server_poweron.md) - Power On server/s
4749
* [cloudcli server reboot](docs/cloudcli_server_reboot.md) - Reboot server/s
50+
* [cloudcli server rename](docs/cloudcli_server_rename.md) - Rename server
4851
* [cloudcli server snapshot](docs/cloudcli_server_snapshot.md) - List/manage server snapshots
4952
* [cloudcli server sshkey](docs/cloudcli_server_sshkey.md) - Add an SSH public key to the server authorized keys
53+
* [cloudcli server statistics](docs/cloudcli_server_statistics.md) - Get server statistics
5054
* [cloudcli server terminate](docs/cloudcli_server_terminate.md) - Terminate server/s
5155

5256
#### Task queue management

docs/cloudcli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ it's recommended to use a configuration file with appropriate permissions and lo
4141
* [cloudcli server](cloudcli_server.md) - Server management
4242
* [cloudcli version](cloudcli_version.md) - Get the cloudcli version
4343

44-
###### Auto generated by spf13/cobra on 24-Sep-2019
44+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_init.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,4 +35,4 @@ cloudcli init [flags]
3535

3636
* [cloudcli](cloudcli.md) - Cloudcli server management
3737

38-
###### Auto generated by spf13/cobra on 24-Sep-2019
38+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_queue.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,4 @@ Task queue management
3131
* [cloudcli queue detail](cloudcli_queue_detail.md) - Get details of tasks
3232
* [cloudcli queue list](cloudcli_queue_list.md) - List all tasks in queue
3333

34-
###### Auto generated by spf13/cobra on 24-Sep-2019
34+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_queue_detail.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ cloudcli queue detail [flags]
3737

3838
* [cloudcli queue](cloudcli_queue.md) - Task queue management
3939

40-
###### Auto generated by spf13/cobra on 24-Sep-2019
40+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_queue_list.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,4 +33,4 @@ cloudcli queue list [flags]
3333

3434
* [cloudcli queue](cloudcli_queue.md) - Task queue management
3535

36-
###### Auto generated by spf13/cobra on 24-Sep-2019
36+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_server.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,12 @@ Server management
2929

3030
* [cloudcli](cloudcli.md) - Cloudcli server management
3131
* [cloudcli server attach](cloudcli_server_attach.md) - Connect to the server via SSH
32+
* [cloudcli server clone](cloudcli_server_clone.md) - Clone a server
3233
* [cloudcli server configure](cloudcli_server_configure.md) - Change server configuration
3334
* [cloudcli server create](cloudcli_server_create.md) - Create a server
3435
* [cloudcli server description](cloudcli_server_description.md) - Get or set server description
3536
* [cloudcli server disk](cloudcli_server_disk.md) - List/manage server disks
37+
* [cloudcli server history](cloudcli_server_history.md) - List server actions history
3638
* [cloudcli server info](cloudcli_server_info.md) - Get server overview/information
3739
* [cloudcli server list](cloudcli_server_list.md) - List servers
3840
* [cloudcli server network](cloudcli_server_network.md) - List/manage server networks
@@ -41,8 +43,10 @@ Server management
4143
* [cloudcli server poweroff](cloudcli_server_poweroff.md) - Power Off server/s
4244
* [cloudcli server poweron](cloudcli_server_poweron.md) - Power On server/s
4345
* [cloudcli server reboot](cloudcli_server_reboot.md) - Reboot server/s
46+
* [cloudcli server rename](cloudcli_server_rename.md) - Rename server
4447
* [cloudcli server snapshot](cloudcli_server_snapshot.md) - List/manage server snapshots
4548
* [cloudcli server sshkey](cloudcli_server_sshkey.md) - Add an SSH public key to the server authorized keys
49+
* [cloudcli server statistics](cloudcli_server_statistics.md) - Get server statistics
4650
* [cloudcli server terminate](cloudcli_server_terminate.md) - Terminate server/s
4751

48-
###### Auto generated by spf13/cobra on 24-Sep-2019
52+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_server_attach.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ cloudcli server attach [flags]
3737

3838
* [cloudcli server](cloudcli_server.md) - Server management
3939

40-
###### Auto generated by spf13/cobra on 24-Sep-2019
40+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_server_clone.md

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
## cloudcli server clone
2+
3+
Clone a server
4+
5+
### Synopsis
6+
7+
Clone a server
8+
9+
```
10+
cloudcli server clone [flags]
11+
```
12+
13+
### Options
14+
15+
```
16+
--source-id string Source server ID to clone
17+
--source-name string Source server name or regular expression matching a single server to clone
18+
--name string Server name (a-zA-Z0-9()_-). (must be at least 4 characters long, mandatory)
19+
--cpu string CPU count and type. (optional, default from source server) (default "1B")
20+
--ram string Size of server ram in MiB. (optional, default from source server) (default "1024")
21+
--disk stringArray Configure Persistent Disks, Up to 4 disks allowed. (optional, if provided overrides all source server disks)
22+
--disk id=ID,size=SIZE --disk <DISK2>..
23+
ID: first disk # is 0. (optional, default is auto-incremented starting from 0)
24+
SIZE: in GiB. (optional, defaults to one 20GB disk) (default ["id=0,size=20"])
25+
--network stringArray Configure networking, up to 4 networks allowed. (optional, if provided overrides all source server networks)
26+
--network id=ID,name=NAME,ip=IP --network <NETWORK2>..
27+
ID: first network # is 0. (optional, default is auto-incremented starting from 0)
28+
NAME: Set the network VLAN name, set 'wan' for wan interface, otherwise, set the name of an existing lan. (mandatory)
29+
IP: Set the IP address of the server’s network interface. Set 'auto' for auto allocation. (mandatory) (default ["id=0,name=wan,ip=auto"])
30+
--password string Server password (a-z, A-Z, 0-9, !@#$^&*()~). (must be 10-20 characters long with at least 1 capital letter, 1 small letter and 1 digit, mandatory)
31+
--dailybackup string Set Daily Backup (yes | no). (optional, default from source server) (default "no")
32+
--managed string Set Managed Hosting Services (yes | no). (optional, default from source server) (default "no")
33+
--quantity string Number of servers to create, up to 50 servers. (optional, default from source server) (default "1")
34+
--billingcycle string Servers' Billing Cycle. (hourly | monthly) (optional, default from source server) (default "hourly")
35+
--monthlypackage string Monthly billing cycle package (see server options subcommand). (optional in monthly billing cycle, default from source server) (default "t5000")
36+
--poweronaftercreate string Power on server after server created. (optional, default: yes, not copied from source server) (default "yes")
37+
--wait Wait for command execution to finish only then exit cli.
38+
--ssh-key string Path to public key file, adds to server authorized keys after create is done. (requires --wait, not cloned from server server)
39+
-h, --help help for clone
40+
```
41+
42+
### Options inherited from parent commands
43+
44+
```
45+
--api-clientid string API Client ID
46+
--api-secret string API Secret
47+
--api-server string API Server Hostname
48+
--config string config file (default is $HOME/.cloudcli.yaml)
49+
--debug enable debug output to stderr
50+
--dryrun enable dry run mode, does not perform actions
51+
--format string output format, default format is a human readable summary
52+
--no-config disable loading from config file
53+
```
54+
55+
### SEE ALSO
56+
57+
* [cloudcli server](cloudcli_server.md) - Server management
58+
59+
###### Auto generated by spf13/cobra on 25-Nov-2019

docs/cloudcli_server_configure.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,16 @@ cloudcli server configure [flags]
1313
### Options
1414

1515
```
16-
--cpu string CPU count and type (see server options)
17-
-h, --help help for configure
18-
--id string Specific server UUID
19-
--name string Server name or regular expression matching a single server
20-
--ram string Size of server ram in MiB (see server options)
21-
--wait Wait for command execution to finish only then exit cli.
16+
--billingcycle string Server billing cycle (hourly | monthly)
17+
--cpu string CPU count and type (see server options)
18+
--dailybackup string Enable or disable daily backup (yes | no)
19+
-h, --help help for configure
20+
--id string Specific server UUID
21+
--managed string Enable or disable managed hosting services (yes | no)
22+
--monthlypackage string Required when billingcycle is monthly, run without this flag to get the available options
23+
--name string Server name or regular expression matching a single server
24+
--ram string Size of server ram in MiB (see server options)
25+
--wait Wait for command execution to finish only then exit cli.
2226
```
2327

2428
### Options inherited from parent commands
@@ -38,4 +42,4 @@ cloudcli server configure [flags]
3842

3943
* [cloudcli server](cloudcli_server.md) - Server management
4044

41-
###### Auto generated by spf13/cobra on 24-Sep-2019
45+
###### Auto generated by spf13/cobra on 25-Nov-2019

0 commit comments

Comments
 (0)