endevor list environments

zowe › endevor › list › environments

The list environments command lists environments in Endevor

zowe endevor list environments [environment] [options]

--maxrc (number)
- The return code of a failed action
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.

--path | --pa (string)
- Specifies a PHYsical or LOGical path.
  
  Allowed values: log, phy
--return | --ret (string)
- Sets mapping options for returned results: return FIRst match or ALL matching results.
  
  Allowed values: fir, all
--search | --sea (boolean)
- Enables the search through the Endevor map.

--full-output | --fo (boolean)
- Specify this option if you want a full output of list action.
--suppress-messages | --sm (boolean)
- Suppress all [INFO]/[WARN] messages from terminal output.
--file-name | --fn (string)
- File name for saving output messages from Endevor locally.

--host | --hostname (string)
- Specifies the base host name.
--port | -p (string)
- Specifies the port number.
--protocol | --prot (string)
- Specifies the protocol used for connecting to Endevor Rest API
  
  Default value: https
  Allowed values: http, https
--user | --username (string)
- Specifies the user name.
--password | --pass (string)
- Specifies the user's password.
--reject-unauthorized | --ru (boolean)
- Specify this option to have the server certificate verified against the list of supplied CAs
--base-path | --bp (string)
- Specifies the base path used for connecting to Endevor Rest API

--endevor-profile | --endevor-p (string)
- The name of a (endevor) profile to load for this command execution.
--endevor-location-profile | --endevor-location-p (string)
- The name of a (endevor-location) profile to load for this command execution.
--base-profile | --base-p (string)
- The name of a (base) profile to load for this command execution.

--token-type | --tt (string)
- The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.
--token-value | --tv (string)
- The value of the token to pass to the API.
--cert-file (local file path)
- The file path to a certificate file to use for authentication
--cert-key-file (local file path)
- The file path to a certificate key file to use for authentication

--response-format-filter | --rff (array)
- Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.
--response-format-type | --rft (string)
- The command response output format type. Must be one of the following:
  
  table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.
  
  list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.
  
  object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.
  
  string: Formats output data as a string. JSON objects/arrays are stringified.
  
  Allowed values: table, list, object, string
--response-format-header | --rfh (boolean)
- If "--response-format-type table" is specified, include the column headers in the output.

List all environments in Endevor with endevor profile set up:
- zowe endevor list environments -i ENDEVOR