Skip to content

Commit

Permalink
chore(docs): regenerate documentation with METAL_CONFIG
Browse files Browse the repository at this point in the history
Signed-off-by: Marques Johansson <mjohansson@equinix.com>
  • Loading branch information
displague committed Dec 20, 2023
1 parent d6c06a6 commit 8c3b9d0
Show file tree
Hide file tree
Showing 85 changed files with 85 additions and 85 deletions.
2 changes: 1 addition & 1 deletion docs/metal.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Command line interface for Equinix Metal
### Options

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
-h, --help help for metal
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_2fa.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Enable or disable two-factor authentication on your user account or receive an O
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_2fa_disable.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ metal 2fa disable (-a | -s) --code <OTP_code> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_2fa_enable.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ metal 2fa enable (-s | -a) --code <OTP_code> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_2fa_receive.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ metal 2fa receive (-s | -a) [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_capacity.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Capacity operations. For more information on capacity in metros, visit https://m
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_capacity_check.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ metal capacity check (-m <metro> | -f <facility>) -P <plan> -q <quantity> [flags
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_capacity_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ metal capacity get [-m | -f] | [--metros <list> | --facilities <list>] [-P <list
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ metal completion [bash | zsh | fish | powershell]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Device operations that control server provisioning, metadata, and basic operatio
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ metal device create -p <project_id> (-m <metro> | -f <facility>) -P <plan> -H <h
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ metal device delete -i <device_id> [-f] [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ metal device get [-p <project_id>] | [-i <device_id>] [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_reboot.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ metal device reboot -i <device_id> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_reinstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ metal device reinstall --id <device-id> [--operating-system <os_slug>] [--deprov
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ metal device start -i <device_id> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_stop.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ metal device stop -i <device_id> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_device_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ metal device update -i <device_id> [-H <hostname>] [-d <description>] [--locked
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ metal docs <destination>
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_emdocs.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ metal emdocs <destination>
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_env.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ metal env [-p <project_id>]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_event.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Events information for organizations, projects, devices, and the current user.
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_event_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ metal event get [-p <project_id>] | [-d <device_id>] | [-i <event_id>] | [-O <or
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_facilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Information about specific facilities. Facility-level operations have mostly bee
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_facilities_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ metal facilities get [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Metal Gateway provides a single IPv4 address as a gateway for a subnet. For mo
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_gateway_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ metal gateway create -p <project_UUID> --virtual-network <virtual_network_UUID>
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_gateway_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ metal gateway delete -i <metal_gateway_UUID> [-f] [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_gateway_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ metal gateway get -p <project_UUID> [flags]
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_hardware-reservation.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Information and operations on Hardware Reservations. Provisioning specific devic
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
2 changes: 1 addition & 1 deletion docs/metal_hardware-reservation_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ metal hardware-reservation get [-p <project_id>] | [-i <hardware_reservation_id>
### Options inherited from parent commands

```
--config string Path to JSON or YAML configuration file
--config string Path to JSON or YAML configuration file (METAL_CONFIG)
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
Expand Down
Loading

0 comments on commit 8c3b9d0

Please sign in to comment.