list-environments¶

Description¶

Lists environments.

Synopsis¶

  list-environments
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

environments -> (array)

The environment.

item -> (object)

The environment summary.

environmentName -> (string)

Name of the environment.

crn -> (string)

CRN of the environment.

status -> (string)

Status of the environment,

region -> (string)

Region of the environment.

cloudPlatform -> (string)

Cloud platform of the environment.

credentialName -> (string)

Name of the credential of the environment. Must contain only lowercase letters, numbers and hyphens.

description -> (string)

Description of the environment.

created -> (datetime)

Creation date

proxyConfigName -> (string)

Name of the proxy config of the environment.

computeClusterEnabled -> (boolean)

Compute clusters enabled

Form Factors¶

public, private