GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  GCLOUD_TOPIC_FORMATS (1)

NAME

gcloud topic formats - resource formats supplementary help

CONTENTS

DESCRIPTION

Most gcloud commands return a list of resources on success. By default they are pretty-printed on the standard output. The --format=NAME[ATTRIBUTES](PROJECTION) flag changes the default output:

NAME

The format name.
ATTRIBUTES
Format specific attributes. Resource formats are described in detail below.
PROJECTION
A list of resource keys that selects the data listed. For details run $ gcloud topic projections.
resource keys
Keys are names for resource resource items. For details run $ gcloud topic resource-keys. Most gcloud list commands have a --filter=EXPRESSION flag that selects resources to be listed. For details run $ gcloud topic filters.

Formats

A format expression has 3 parts:

NAME

name
ATTRIBUTES
[ [no-]attribute-name[=value] [, ... ] ]
PROJECTION
( resource-key [, ...] ) NAME is required, ATTRIBUTES are optional, and PROJECTIONS may be required for some formats. Unknown attribute names are silently ignored.

Each gcloud list command has a default format expression. The --format flag can alter or replace the default. For example,

--format=’[box]’

adds box decorations to a default table, and

--format=json

lists the resource in json format.

The formats and format specific attributes are:

csv

Comma Separated Values (http://www.ietf.org/rfc/rfc4180.txt) with no keys. This format requires a projection to define the values to be printed.

The format attributes are:

no-heading

Disables the initial key name heading record.

default
An alias for the yaml format.

flattened
A flattened tree. Each output line contains one key:value pair.

The format attributes are:

no-pad

bool, Print only one space after ’:’. The default adjusts the space to align the values into the same output column. Use no-pad for comparing resource outputs.

json
JSON (http://www.json.org), JavaScript Object Notation.

list
An ordered list of items.

The format attributes are:

empty-legend=SENTENCES

Prints SENTENCES to the status logger if there are no items. The default empty-legend is "Listed 0 items.". no-empty-legend disables the default.
legend=SENTENCES
Prints SENTENCES to the out logger after the last item if there is at least one item.
log=TYPE
Prints the legend to the TYPE logger instead of the default. TYPE may be: out (the default), status (standard error), debug, info, warn, or error.

multi
Each projection key must have a subformat defined by the :format=FORMAT-STRING attribute. For example, --format=’multi(data:format=json, info:format="table[box](a, b, c)")’ formats the data field as JSON and the info field as a boxed table.

none
Disables formatted output and consumes the resources.

table
Aligned left-adjusted columns with optional title, column headings and sorting. This format requires a projection to define the table columns. The default column headings are the disambiguated right hand components of the column keys in ANGRY_SNAKE_CASE. For example, the projection keys (first.name, last.name) produce the default column heading (’NAME’, ’LAST_NAME’).

The format attributes are:

box

Prints a box around the entire table and each cell, including the title if any.
empty-legend=SENTENCES
Prints SENTENCES to the status logger if there are no items. The default empty-legend is "Listed 0 items.". no-empty-legend disables the default.
no-heading
Disables the column headings.
legend=SENTENCES
Prints SENTENCES to the out logger after the last item if there is at least one item.
log=TYPE
Prints the legend to the TYPE logger instead of the default. TYPE may be: out (the default), status (standard error), debug, info, warn, or error.
pad=N
Sets the column horizontal pad to N spaces. The default is 1 for box, 2 otherwise.
page=N
If N > 0 then output is grouped into tables with N rows. The last table may have less rows. Headings, alignment and sorting are done per-page. The title, if any, is printed before the first table. The legend, if any, is printed after the last table.
title=TITLE
Prints a centered TITLE at the top of the table, within the table box if box is enabled.

text
An alias for the flattened format.

value
CSV with no heading and <TAB> delimiter instead of <COMMA>, and a legend. Used to retrieve individual resource values. This format requires a projection to define the value(s) to be printed.

The format attributes are:

empty-legend=SENTENCES

Prints SENTENCES to the status logger if there are no items. The default empty-legend is "Listed 0 items.". no-empty-legend disables the default.
legend=SENTENCES
Prints SENTENCES to the out logger after the last item if there is at least one item.
log=TYPE
Prints the legend to the TYPE logger instead of the default. TYPE may be: out (the default), status (standard error), debug, info, warn, or error.
no-quote
Prints NEWLINE terminated TAB delimited values with no quoting.

yaml
YAML (http://www.yaml.org), YAML ain’t markup language.

All formats have these attributes:

disable

Disables formatted output and does not consume the resources.
private
Disables log file output. Use this for sensitive resource data that should not be displayed in log files. Explicit command line IO redirection overrides this attribute.

EXAMPLES

List a table of compute instance resources sorted by name with box decorations and title Instances:

$ gcloud compute instances list \
--format=’table[box,title=Instances](name:sort=1, zone:title=z\ one, status)’

List the disk interfaces for all compute instances as a compact comma separated list:

$ gcloud compute instances list \
--format=’value(disks[].interface.list())’

List the URIs for all compute instances:

$ gcloud compute instances list --format=’value(uri())’

List the project authenticated user email address:

$ gcloud info --format=’value(config.account)’
Search for    or go to Top of page |  Section 1 |  Main Index


GCLOUD_TOPIC_FORMATS (1) -->

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.