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