Skip to content

Commit 8f9c173

Browse files
ad-mad-m
committed
Update docs
1 parent 596e620 commit 8f9c173

File tree

10 files changed

+1754
-202
lines changed

10 files changed

+1754
-202
lines changed

‎docs/compute.md

Lines changed: 169 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -606,6 +606,7 @@ Command List
606606
flavour Flavour compute/vm [compute_project_vm_flavour]
607607
console Console compute/vm [compute_project_vm_console]
608608
serialport Serialport compute/vm [compute_project_vm_serialport]
609+
metric Manage metrics of the vm
609610
disk Manage disks of the vm
610611
iso Manage isos of the vm
611612
service Manage services of the vm
@@ -670,22 +671,22 @@ Global options
670671
671672
Operation options
672673
673-
--project id-or-uri Project Id
674-
--location id-or-uri Location Id
675-
--x-idempotency-key string Idempotency key
676-
--name string Vm name
677-
--service id-or-uri Vm service. Provide ID or URI of billing/service
678-
--image id-or-uri Vm image. Provide ID or URI of storage/image. Requires permissions
679-
storage/image/use
680-
--iso id-or-uri Vm iso. Provide ID or URI of storage/iso. Requires permissions
681-
storage/iso/use
682-
--username string Vm username
683-
--user-metadata string Vm userMetadata
684-
--start true,false Vm start. Defaults is true
685-
--credential type=type,value=value Credential collection
686-
--disk name=name,service=service,size=size Disk collection
687-
--netadp network=network,firewall=firewall,ip=ip Netadp collection
688-
--tag key=key,value=value Tag collection
674+
--project id-or-uri Project Id
675+
--location id-or-uri Location Id
676+
--x-idempotency-key string Idempotency key
677+
--name string Vm name
678+
--service id-or-uri Vm service. Provide ID or URI of billing/service
679+
--image id-or-uri Vm image. Provide ID or URI of storage/image. Requires
680+
permissions storage/image/use
681+
--iso id-or-uri Vm iso. Provide ID or URI of storage/iso. Requires permissions
682+
storage/iso/use
683+
--username string Vm username
684+
--user-metadata string Vm userMetadata
685+
--start true,false Vm start. Defaults is true
686+
--credential type=type,value=value Credential collection
687+
--disk name=name,service=service,size=size Disk collection
688+
--netadp network=network,firewall=firewall,ip=ip Netadp collection
689+
--tag key=key,value=value Tag collection
689690
--skeleton true,false
690691
```
691692

@@ -700,6 +701,13 @@ Synopsis
700701
701702
$ h1 compute vm list <options>
702703
704+
Example
705+
706+
707+
Simple
708+
709+
$ h1 compute vm list --project 5f64e2468c71177993874510
710+
703711
Global options
704712
705713
--help Show help message and exit.
@@ -731,6 +739,14 @@ Synopsis
731739
732740
$ h1 compute vm show <options>
733741
742+
Example
743+
744+
745+
Simple
746+
747+
$ h1 compute vm show --project 5f64e2468c71177993874510 --vm
748+
5f577a24494c5cfdec7830e5
749+
734750
Global options
735751
736752
--help Show help message and exit.
@@ -799,6 +815,14 @@ Synopsis
799815
800816
$ h1 compute vm delete <options>
801817
818+
Example
819+
820+
821+
Simple
822+
823+
$ h1 compute vm delete --project 5f64e2468c71177993874510 --vm
824+
5f577a24494c5cfdec7830e5
825+
802826
Global options
803827
804828
--help Show help message and exit.
@@ -1062,6 +1086,79 @@ Operation options
10621086
--skeleton true,false
10631087
```
10641088

1089+
#### h1 compute vm metric
1090+
1091+
```
1092+
h1 compute vm metric
1093+
1094+
Synopsis
1095+
1096+
$ h1 compute vm metric <group> <command>
1097+
1098+
Options
1099+
1100+
--help Show help message and exit.
1101+
1102+
Command List
1103+
1104+
spec Print specification of context
1105+
list List compute/vm.metric [compute_project_vm_metric_list]
1106+
```
1107+
1108+
##### h1 compute vm metric spec
1109+
1110+
```
1111+
h1 compute vm metric spec
1112+
1113+
Print specification of context
1114+
1115+
Synopsis
1116+
1117+
$ h1 compute vm metric spec <options>
1118+
1119+
Global options
1120+
1121+
--help Show help message and exit.
1122+
--verbose Make the operation more talkative.
1123+
-o, --output tsv,list,json,js,id,uri,yaml Specify output format of command
1124+
--query string JMESPath query string
1125+
--passport-file path Passport file. Defaults to ~/.h1/passport.json.
1126+
--as uri Act as another actor eg. service account
1127+
--no-wait true,false In case of queued event do not wait for completion
1128+
1129+
Operation options
1130+
```
1131+
1132+
##### h1 compute vm metric list
1133+
1134+
```
1135+
h1 compute vm metric list
1136+
1137+
List compute/vm.metric [compute_project_vm_metric_list]
1138+
1139+
Synopsis
1140+
1141+
$ h1 compute vm metric list <options>
1142+
1143+
Global options
1144+
1145+
--help Show help message and exit.
1146+
--verbose Make the operation more talkative.
1147+
-o, --output tsv,list,json,js,id,uri,yaml Specify output format of command
1148+
--query string JMESPath query string
1149+
--passport-file path Passport file. Defaults to ~/.h1/passport.json.
1150+
--as uri Act as another actor eg. service account
1151+
--no-wait true,false In case of queued event do not wait for completion
1152+
1153+
Operation options
1154+
1155+
--project id-or-uri Project Id
1156+
--location id-or-uri Location Id
1157+
--vm id-or-uri Vm Id
1158+
--period string period
1159+
--skeleton true,false
1160+
```
1161+
10651162
#### h1 compute vm disk
10661163

10671164
```
@@ -1325,6 +1422,14 @@ Synopsis
13251422
13261423
$ h1 compute vm service list <options>
13271424
1425+
Example
1426+
1427+
1428+
Simple
1429+
1430+
$ h1 compute vm service list --project 5f64e2468c71177993874510 --vm
1431+
5f577a24494c5cfdec7830e5
1432+
13281433
Global options
13291434
13301435
--help Show help message and exit.
@@ -1354,6 +1459,14 @@ Synopsis
13541459
13551460
$ h1 compute vm service show <options>
13561461
1462+
Example
1463+
1464+
1465+
Simple
1466+
1467+
$ h1 compute vm service show --project 5f64e2468c71177993874510 --vm
1468+
5f577a24494c5cfdec7830e5 --service 5f60cbbe494c5cfdec81cc6b
1469+
13571470
Global options
13581471
13591472
--help Show help message and exit.
@@ -1469,6 +1582,14 @@ Synopsis
14691582
14701583
$ h1 compute vm tag list <options>
14711584
1585+
Example
1586+
1587+
1588+
Simple
1589+
1590+
$ h1 compute vm tag list --project 5f64e2468c71177993874510 --vm
1591+
5f577a24494c5cfdec7830e5
1592+
14721593
Global options
14731594
14741595
--help Show help message and exit.
@@ -1498,6 +1619,14 @@ Synopsis
14981619
14991620
$ h1 compute vm tag show <options>
15001621
1622+
Example
1623+
1624+
1625+
Simple
1626+
1627+
$ h1 compute vm tag show --project 5f64e2468c71177993874510 --vm
1628+
5f577a24494c5cfdec7830e5 --tag 5f60cbbe494c5cfdec81cc6b
1629+
15011630
Global options
15021631
15031632
--help Show help message and exit.
@@ -1528,6 +1657,14 @@ Synopsis
15281657
15291658
$ h1 compute vm tag delete <options>
15301659
1660+
Example
1661+
1662+
1663+
Simple
1664+
1665+
$ h1 compute vm tag delete --project 5f64e2468c71177993874510 --vm
1666+
5f577a24494c5cfdec7830e5 --tag 5f60cbbe494c5cfdec81cc6b
1667+
15311668
Global options
15321669
15331670
--help Show help message and exit.
@@ -1602,6 +1739,14 @@ Synopsis
16021739
16031740
$ h1 compute vm event list <options>
16041741
1742+
Example
1743+
1744+
1745+
Simple
1746+
1747+
$ h1 compute vm event list --project 5f64e2468c71177993874510 --vm
1748+
5f577a24494c5cfdec7830e5
1749+
16051750
Global options
16061751
16071752
--help Show help message and exit.
@@ -1633,6 +1778,14 @@ Synopsis
16331778
16341779
$ h1 compute vm event show <options>
16351780
1781+
Example
1782+
1783+
1784+
Simple
1785+
1786+
$ h1 compute vm event show --project 5f64e2468c71177993874510 --vm
1787+
5f577a24494c5cfdec7830e5 --event 5f60cbbe494c5cfdec81cc6b
1788+
16361789
Global options
16371790
16381791
--help Show help message and exit.

0 commit comments

Comments
 (0)