.\" This file was pre-generated by "help2man --no-info --no-discard-stderr" 1.47.1.
.TH FLEETCTL "1" "September 2015" "fleetctl version 0.11.5" "User Commands"
.SH NAME
fleetctl \- fleetctl is a command\-line interface to fleet, the cluster\-wide CoreOS init system.
.SH SYNOPSIS
.IP
fleetctl [global options] <command> [command options] [arguments...]
.SS "VERSION:"
.IP
0.11.5
.SH DESCRIPTION
.SS "COMMANDS:"
.TP
cat
Output the contents of a submitted unit
.TP
destroy
Destroy one or more units in the cluster
.TP
fd\-forward
Proxy stdin and stdout to a unix domain socket
.TP
help
Show a list of commands or help for one command
.TP
journal
Print the journal of a unit in the cluster to stdout
.TP
list\-machines
Enumerate the current hosts in the cluster
.TP
list\-unit\-files
List the units that exist in the cluster.
.TP
list\-units
List the current state of units in the cluster
.TP
load
Schedule one or more units in the cluster, first submitting them if necessary.
.TP
ssh
Open interactive shell on a machine in the cluster
.TP
start
Instruct systemd to start one or more units in the cluster, first submitting and loading if necessary.
.TP
status
Output the status of one or more units in the cluster
.TP
stop
Instruct systemd to stop one or more units in the cluster.
.TP
submit
Upload one or more units to the cluster without starting them
.TP
unload
Unschedule one or more units in the cluster.
.TP
verify
DEPRECATED \- No longer works
.TP
version
Print the version and exit
.SS "GLOBAL OPTIONS:"
.TP
\fB\-\-ca\-file=\fR
Location of TLS CA file used to secure communication with the fleet API or etcd
.TP
\fB\-\-cert\-file=\fR
Location of TLS cert file used to secure communication with the fleet API or etcd
.TP
\fB\-\-debug\fR=\fI\,false\/\fR
Print out more debug information to stderr
.TP
\fB\-\-driver\fR=\fI\,API\/\fR
Adapter used to execute fleetctl commands. Options include "API" and "etcd".
.TP
\fB\-\-endpoint\fR=\fI\,unix\/\fR:///var/run/fleet.sock
Location of the fleet API if \fB\-\-driver\fR=\fI\,API\/\fR. Alternatively, if \fB\-\-driver\fR=\fI\,etcd\/\fR, location of the etcd API.
.TP
\fB\-\-etcd\-key\-prefix=\fR/_coreos.com/fleet/
Keyspace for fleet data in etcd (development use only!)
.TP
\fB\-h\fR=\fI\,false\/\fR
Print usage information and exit
.TP
\fB\-\-help\fR=\fI\,false\/\fR
Print usage information and exit
.TP
\fB\-\-key\-file=\fR
Location of TLS key file used to secure communication with the fleet API or etcd
.TP
\fB\-\-known\-hosts\-file=\fR~/.fleetctl/known_hosts
File used to store remote machine fingerprints. Ignored if strict host key checking is disabled.
.TP
\fB\-\-request\-timeout\fR=\fI\,3\/\fR
Amount of time in seconds to allow a single request before considering it failed.
.TP
\fB\-\-ssh\-timeout\fR=\fI\,10\/\fR
Amount of time in seconds to allow for SSH connection initialization before failing.
.TP
\fB\-\-ssh\-username\fR=\fI\,core\/\fR
Username to use when connecting to CoreOS instance.
.TP
\fB\-\-strict\-host\-key\-checking\fR=\fI\,true\/\fR
Verify host keys presented by remote machines before initiating SSH connections.
.TP
\fB\-\-tunnel=\fR
Establish an SSH tunnel through the provided address for communication with fleet and etcd.
.TP
\fB\-\-version\fR=\fI\,false\/\fR
Print the version and exit
.PP
Global options can also be configured via upper\-case environment variables prefixed with "FLEETCTL_"
For example, "some\-flag" => "FLEETCTL_SOME_FLAG"
.PP
Run "fleetctl help <command>" for more details on a specific command.