Skip to content

Commit

Permalink
generate docs with make gen-docs
Browse files Browse the repository at this point in the history
  • Loading branch information
joelrebel committed Sep 7, 2023
1 parent 969a289 commit c1bac5f
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/mctl.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ mctl is a CLI utility to interact with metal toolbox services

### SEE ALSO

* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration
* [mctl completion](mctl_completion.md) - Generate the autocompletion script for the specified shell
* [mctl create](mctl_create.md) - Create resources
* [mctl delete](mctl_delete.md) - Delete resources
Expand Down
29 changes: 29 additions & 0 deletions docs/mctl_collect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
[Auto generated by spf13/cobra]: <>

## mctl collect

Collect current server firmware status and bios configuration

```
mctl collect [flags]
```

### Options

```
-h, --help help for collect
```

### Options inherited from parent commands

```
--config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml)
--reauth re-authenticate with oauth services
```

### SEE ALSO

* [mctl](mctl.md) - mctl is a CLI utility to interact with metal toolbox services
* [mctl collect inventory](mctl_collect_inventory.md) - Collect current server firmware status and bios configuration
* [mctl collect status](mctl_collect_status.md) - check the progress of a inventory collection for a server

30 changes: 30 additions & 0 deletions docs/mctl_collect_inventory.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
[Auto generated by spf13/cobra]: <>

## mctl collect inventory

Collect current server firmware status and bios configuration

```
mctl collect inventory [flags]
```

### Options

```
-h, --help help for inventory
--server string server UUID
--skip-bios-config Skip BIOS configuration data collection
--skip-fw-status Skip firmware status data collection
```

### Options inherited from parent commands

```
--config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml)
--reauth re-authenticate with oauth services
```

### SEE ALSO

* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration

28 changes: 28 additions & 0 deletions docs/mctl_collect_status.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[Auto generated by spf13/cobra]: <>

## mctl collect status

check the progress of a inventory collection for a server

```
mctl collect status --server | -s <server uuid> [flags]
```

### Options

```
-h, --help help for status
-s, --server string server id (typically a UUID)
```

### Options inherited from parent commands

```
--config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml)
--reauth re-authenticate with oauth services
```

### SEE ALSO

* [mctl collect](mctl_collect.md) - Collect current server firmware status and bios configuration

1 change: 1 addition & 0 deletions docs/mctl_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,5 +25,6 @@ mctl delete [flags]

* [mctl](mctl.md) - mctl is a CLI utility to interact with metal toolbox services
* [mctl delete condition](mctl_delete_condition.md) - delete server condition
* [mctl delete firmware](mctl_delete_firmware.md) - Delete a firmware object
* [mctl delete firmware-set](mctl_delete_firmware-set.md) - Delete a firmware set

28 changes: 28 additions & 0 deletions docs/mctl_delete_firmware.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
[Auto generated by spf13/cobra]: <>

## mctl delete firmware

Delete a firmware object

```
mctl delete firmware [flags]
```

### Options

```
-f, --firmware-id string UUID of firmware object to be deleted
-h, --help help for firmware
```

### Options inherited from parent commands

```
--config string config file (default is $XDG_CONFIG_HOME/mctl/config.yml)
--reauth re-authenticate with oauth services
```

### SEE ALSO

* [mctl delete](mctl_delete.md) - Delete resources

0 comments on commit c1bac5f

Please sign in to comment.