talos/docs/osctl/osctl_service.md
Andrew Rynhard 127fa54a76 docs: add docs command to osctl
This allows osctl to generate documentation for itself.

Signed-off-by: Andrew Rynhard <andrew@andrewrynhard.com>
2019-11-13 17:14:53 -08:00

34 lines
908 B
Markdown

<!-- markdownlint-disable -->
## osctl service
Retrieve the state of a service (or all services), control service state
### Synopsis
Service control command. If run without arguments, lists all the services and their state.
If service ID is specified, default action 'status' is executed which shows status of a single list service.
With actions 'start', 'stop', 'restart', service state is updated respectively.
```
osctl service [<id> [start|stop|restart|status]] [flags]
```
### Options
```
-h, --help help for service
```
### Options inherited from parent commands
```
--talosconfig string The path to the Talos configuration file (default "/root/.talos/config")
-t, --target strings target the specificed node
```
### SEE ALSO
* [osctl](osctl.md) - A CLI for out-of-band management of Kubernetes nodes created by Talos
###### Auto generated by spf13/cobra on 13-Nov-2019