make gen-docs for - mctl list component

metal-toolbox · Oct 17, 2023 · fd42322 · fd42322
1 parent cd26884
commit fd42322
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 0 deletions.
diff --git a/docs/mctl_list.md b/docs/mctl_list.md
@@ -25,6 +25,7 @@ mctl list [flags]
 ### SEE ALSO
 
 * [mctl](mctl.md)	 - mctl is a CLI utility to interact with metal toolbox services
+* [mctl list component](mctl_list_component.md)	 - List Components
 * [mctl list condition](mctl_list_condition.md)	 - list server conditions by state
 * [mctl list firmware](mctl_list_firmware.md)	 - List firmware
 * [mctl list firmware-set](mctl_list_firmware-set.md)	 - List firmware

diff --git a/docs/mctl_list_component.md b/docs/mctl_list_component.md
@@ -0,0 +1,34 @@
+[Auto generated by spf13/cobra]: <>
+
+## mctl list component
+
+List Components
+
+```
+mctl list component [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for component
+      --limit int       limit results returned (default 10)
+      --model string    filter by one or more component models
+      --page int        limit results to page (for use with --limit)
+      --records         print record count found with pagination info and return
+      --slug string     filter by component slug (nic/drive/bmc/bios...)
+      --vendor string   filter by component vendor
+```
+
+### Options inherited from parent commands
+
+```
+      --config string   config file (default is $XDG_CONFIG_HOME/mctl/config.yml)
+      --output-json     Output listing as JSON
+      --reauth          re-authenticate with oauth services
+```
+
+### SEE ALSO
+
+* [mctl list](mctl_list.md)	 - List resources
+