Update docs.

metal-stack · Jun 22, 2023 · d037f35 · d037f35
1 parent a940050
commit d037f35
Show file tree

Hide file tree

Showing 12 changed files with 22 additions and 20 deletions.
diff --git a/docs/metalctl_filesystemlayout_delete.md b/docs/metalctl_filesystemlayout_delete.md
@@ -16,9 +16,9 @@ metalctl filesystemlayout delete <id> [flags]
                       $ metalctl filesystemlayout describe filesystemlayout-1 -o yaml > filesystemlayout.yaml
                       $ vi filesystemlayout.yaml
                       $ # either via stdin
-                      $ cat filesystemlayout.yaml | metalctl filesystemlayout delete -f -
+                      $ cat filesystemlayout.yaml | metalctl filesystemlayout delete <id> -f -
                       $ # or via file
-                      $ metalctl filesystemlayout delete -f filesystemlayout.yaml
+                      $ metalctl filesystemlayout delete <id> -f filesystemlayout.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_image_delete.md b/docs/metalctl_image_delete.md
@@ -16,9 +16,9 @@ metalctl image delete <id> [flags]
                       $ metalctl image describe image-1 -o yaml > image.yaml
                       $ vi image.yaml
                       $ # either via stdin
-                      $ cat image.yaml | metalctl image delete -f -
+                      $ cat image.yaml | metalctl image delete <id> -f -
                       $ # or via file
-                      $ metalctl image delete -f image.yaml
+                      $ metalctl image delete <id> -f image.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_machine_delete.md b/docs/metalctl_machine_delete.md
@@ -20,9 +20,9 @@ metalctl machine delete <id> [flags]
                                $ metalctl machine describe machine-1 -o yaml > machine.yaml
                                $ vi machine.yaml
                                $ # either via stdin
-                               $ cat machine.yaml | metalctl machine delete -f -
+                               $ cat machine.yaml | metalctl machine delete <id> -f -
                                $ # or via file
-                               $ metalctl machine delete -f machine.yaml
+                               $ metalctl machine delete <id> -f machine.yaml
                                
                                the file can also contain multiple documents and perform a bulk operation.
                                	

diff --git a/docs/metalctl_machine_ipmi.md b/docs/metalctl_machine_ipmi.md
@@ -36,6 +36,7 @@ metalctl machine ipmi [<machine ID>] [flags]
       --project string                        allocation project to filter [optional]
       --rack string                           rack to filter [optional]
       --size string                           size to filter [optional]
+      --sort-by strings                       sort by (comma separated) column(s), sort direction can be changed by appending :asc or :desc behind the column identifier. possible values: age|bios|bmc|event|id|liveliness|partition|project|rack|size|when
       --state string                          state to filter [optional]
       --tags strings                          tags to filter, use it like: --tags "tag1,tag2" or --tags "tag3".
 ```

diff --git a/docs/metalctl_machine_issues.md b/docs/metalctl_machine_issues.md
@@ -39,6 +39,7 @@ metalctl machine issues [<machine ID>] [flags]
       --rack string                           rack to filter [optional]
       --severity string                       issue severity to include [optional]
       --size string                           size to filter [optional]
+      --sort-by strings                       sort by (comma separated) column(s), sort direction can be changed by appending :asc or :desc behind the column identifier. possible values: age|bios|bmc|event|id|liveliness|partition|project|rack|size|when
       --state string                          state to filter [optional]
       --tags strings                          tags to filter, use it like: --tags "tag1,tag2" or --tags "tag3".
 ```

diff --git a/docs/metalctl_network_delete.md b/docs/metalctl_network_delete.md
@@ -16,9 +16,9 @@ metalctl network delete <id> [flags]
                       $ metalctl network describe network-1 -o yaml > network.yaml
                       $ vi network.yaml
                       $ # either via stdin
-                      $ cat network.yaml | metalctl network delete -f -
+                      $ cat network.yaml | metalctl network delete <id> -f -
                       $ # or via file
-                      $ metalctl network delete -f network.yaml
+                      $ metalctl network delete <id> -f network.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_network_ip_delete.md b/docs/metalctl_network_ip_delete.md
@@ -16,9 +16,9 @@ metalctl network ip delete <id> [flags]
                       $ metalctl ip describe ip-1 -o yaml > ip.yaml
                       $ vi ip.yaml
                       $ # either via stdin
-                      $ cat ip.yaml | metalctl ip delete -f -
+                      $ cat ip.yaml | metalctl ip delete <id> -f -
                       $ # or via file
-                      $ metalctl ip delete -f ip.yaml
+                      $ metalctl ip delete <id> -f ip.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_partition_delete.md b/docs/metalctl_partition_delete.md
@@ -16,9 +16,9 @@ metalctl partition delete <id> [flags]
                       $ metalctl partition describe partition-1 -o yaml > partition.yaml
                       $ vi partition.yaml
                       $ # either via stdin
-                      $ cat partition.yaml | metalctl partition delete -f -
+                      $ cat partition.yaml | metalctl partition delete <id> -f -
                       $ # or via file
-                      $ metalctl partition delete -f partition.yaml
+                      $ metalctl partition delete <id> -f partition.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_project_delete.md b/docs/metalctl_project_delete.md
@@ -16,9 +16,9 @@ metalctl project delete <id> [flags]
                       $ metalctl project describe project-1 -o yaml > project.yaml
                       $ vi project.yaml
                       $ # either via stdin
-                      $ cat project.yaml | metalctl project delete -f -
+                      $ cat project.yaml | metalctl project delete <id> -f -
                       $ # or via file
-                      $ metalctl project delete -f project.yaml
+                      $ metalctl project delete <id> -f project.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_size_delete.md b/docs/metalctl_size_delete.md
@@ -16,9 +16,9 @@ metalctl size delete <id> [flags]
                       $ metalctl size describe size-1 -o yaml > size.yaml
                       $ vi size.yaml
                       $ # either via stdin
-                      $ cat size.yaml | metalctl size delete -f -
+                      $ cat size.yaml | metalctl size delete <id> -f -
                       $ # or via file
-                      $ metalctl size delete -f size.yaml
+                      $ metalctl size delete <id> -f size.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_size_imageconstraint_delete.md b/docs/metalctl_size_imageconstraint_delete.md
@@ -16,9 +16,9 @@ metalctl size imageconstraint delete <id> [flags]
                       $ metalctl imageconstraint describe imageconstraint-1 -o yaml > imageconstraint.yaml
                       $ vi imageconstraint.yaml
                       $ # either via stdin
-                      $ cat imageconstraint.yaml | metalctl imageconstraint delete -f -
+                      $ cat imageconstraint.yaml | metalctl imageconstraint delete <id> -f -
                       $ # or via file
-                      $ metalctl imageconstraint delete -f imageconstraint.yaml
+                      $ metalctl imageconstraint delete <id> -f imageconstraint.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.
                       	

diff --git a/docs/metalctl_switch_delete.md b/docs/metalctl_switch_delete.md
@@ -16,9 +16,9 @@ metalctl switch delete <id> [flags]
                       $ metalctl switch describe switch-1 -o yaml > switch.yaml
                       $ vi switch.yaml
                       $ # either via stdin
-                      $ cat switch.yaml | metalctl switch delete -f -
+                      $ cat switch.yaml | metalctl switch delete <id> -f -
                       $ # or via file
-                      $ metalctl switch delete -f switch.yaml
+                      $ metalctl switch delete <id> -f switch.yaml
                       
                       the file can also contain multiple documents and perform a bulk operation.