Contents
config
config Class for forcing client authorization.
Usage: gcutil [--global_flags] config
[--command_flags]
Flags for config:
gcutil_lib.basic_cmds:
--[no]confirm_email: Get info about the user and echo the email
(default: 'true')
--[no]force_reauth: If True, will force user to reauthorize
(default: 'true')
--[no]just_check_auth: If True, just check if auth exists
(default: 'false')
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
getproject
getproject Get a Google Compute Engine project.
Usage: gcutil [--global_flags] getproject
[--command_flags] <project-name>
getserialportoutput
getserialportoutput Get the output of a VM instance's serial port.
Usage: gcutil [--global_flags] getserialportoutput
[--command_flags] <instance-name>
Flags for getserialportoutput:
gcutil_lib.instance_cmds:
--zone: [Required] The zone for this request.
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
help
Any of the following commands:
addaccessconfig, adddisk, addfirewall, addforwardingrule, addhttphealthcheck,
addimage, addinstance, addnetwork, addroute, addsnapshot, addtargetinstance,
addtargetpool, addtargetpoolhealthcheck, addtargetpoolinstance, attachdisk,
auth, config, deleteaccessconfig, deletedisk, deletefirewall,
deleteforwardingrule, deletehttphealthcheck, deleteimage, deleteinstance,
deletenetwork, deleteoperation, deleteroute, deletesnapshot,
deletetargetinstance, deletetargetpool, deprecateimage, detachdisk,
getaddress, getdisk, getfirewall, getforwardingrule, gethttphealthcheck,
getimage, getinstance, getkernel, getmachinetype, getnetwork, getoperation,
getproject, getregion, getroute, getserialportoutput, getsnapshot,
gettargetinstance, gettargetpool, gettargetpoolhealth, getzone, help,
listaddresses, listdisks, listfirewalls, listforwardingrules,
listhttphealthchecks, listimages, listinstances, listkernels,
listmachinetypes, listnetworks, listoperations, listregions, listroutes,
listsnapshots, listtargetinstances, listtargetpools, listzones, moveinstances,
pull, push, releaseaddress, removetargetpoolhealthcheck,
removetargetpoolinstance, reserveaddress, resetinstance, resumemove,
setcommoninstancemetadata, setforwardingruletarget, setinstancediskautodelete,
setinstancemetadata, setinstancetags, setscheduling, settargetpoolbackup, ssh,
updatehttphealthcheck, version, whoami
help Help for all or selected command:
gcutil help [<command>]
To retrieve help with global flags:
gcutil --help
To retrieve help with flags only from the main
module:
gcutil --helpshort [<command>]
pull
pull Pull one or more files from a VM instance.
Usage: gcutil [--global_flags] pull
[--command_flags] <instance-name> <file-1> ...
<file-n> <destination>
Flags for pull:
gcutil_lib.instance_cmds:
--ssh_arg: Additional arguments to pass to ssh;
repeat this option to specify a list of values
(default: '[]')
--ssh_key_push_wait_time: Number of seconds to wait for updates to
project-wide ssh keys to cascade to the instances within the project
(default: '10')
(an integer)
--ssh_port: TCP port to connect to
(default: '22')
(an integer)
--zone: [Required] The zone for this request.
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
push
push Push one or more files to a VM instance.
Usage: gcutil [--global_flags] push
[--command_flags] <instance-name> <file-1> ...
<file-n> <destination>
Flags for push:
gcutil_lib.instance_cmds:
--ssh_arg: Additional arguments to pass to ssh;
repeat this option to specify a list of values
(default: '[]')
--ssh_key_push_wait_time: Number of seconds to wait for updates to
project-wide ssh keys to cascade to the instances within the project
(default: '10')
(an integer)
--ssh_port: TCP port to connect to
(default: '22')
(an integer)
--zone: [Required] The zone for this request.
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
resumemove
resumemove Resume a previously-failed move.
The moveinstances subcommand produces a log file
that can be used to re-attempt a move that fails.
This is intended to help complete moves that are
interrupted by the user or by transient network
failures.
WARNING: Instances that are moved will lose ALL of
their transient state (i.e., scratch disks,
ephemeral IP addresses, and memory).
Usage: gcutil [--global_flags] resumemove
[--command_flags] <log-path>
Flags for resumemove:
gcutil_lib.move_cmds:
--[no]force: Override the confirmation prompt.
(default: 'false')
--[no]keep_log_file: If true, the log file is not deleted at the end of the
resume.
(default: 'false')
--[no]keep_snapshots: Do not delete snapshots that were created for the disks.
(default: 'false')
--[no]replace_deprecated: Replaces deprecated resource with their recommended
replacement.
(default: 'false')
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
setscheduling
setscheduling Set scheduling options for an instance.
Usage: gcutil [--global_flags] setscheduling
[--command_flags] <instance-name>
Flags for setscheduling:
gcutil_lib.instance_cmds:
--[no]automatic_restart: Whether the instance should be automatically
restarted whenever it is terminated by Compute Engine (not terminated by
user).
--on_host_maintenance: <terminate|migrate>: How the instance should behave
when the host machine undergoes maintenance that may temporarily impact
instance performance. Must be unspecified or 'terminate' for instances with
scratch disk. If unspecified, a default of 'terminate' will be used for
instances with scratch disk, or 'migrate' for instances without scratch
disk.
--zone: [Required] The zone for this request.
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
ssh
ssh Connect to a VM instance with ssh.
Usage: gcutil [--global_flags] ssh
[--command_flags] <instance-name> <ssh-args>
Flags for ssh:
gcutil_lib.instance_cmds:
--ssh_arg: Additional arguments to pass to ssh;
repeat this option to specify a list of values
(default: '[]')
--ssh_key_push_wait_time: Number of seconds to wait for updates to
project-wide ssh keys to cascade to the instances within the project
(default: '10')
(an integer)
--ssh_port: TCP port to connect to
(default: '22')
(an integer)
--zone: [Required] The zone for this request.
gflags:
--flagfile: Insert flag definitions from the given file into the command line.
(default: '')
--undefok: comma-separated list of flag names that it is okay to specify on
the command line even if the program does not define a flag with that name.
IMPORTANT: flags in this list that have arguments MUST use the --flag=value
format.
(default: '')
version
version Get the current version of this command.
Usage: gcutil [--global_flags] version
[--command_flags]
whoami
whoami Identify the authenticated user.