zowe › endevor › add › element🖨️

The add element command lets you add an Element to an Environment entry Stage in Endevor.

Usage

zowe endevor add element <element> [options]

Positional Arguments

• element (string)

  • Name of the Endevor element.

endevor-location definition options

• --environment | --env (string)

  • The Endevor environment where your project resides.

• --system | --sys (string)

  • The Endevor system where your project resides.

• --subsystem | --sub (string)

  • The Endevor subsystem where your project resides.

• --type | --typ (string)

  • Name of the Endevor element's type.

• --ccid | --cci (string)

  • The CCID you want to use when performing an Element action.

• --comment | --com (string)

  • The comment you want to have when performing an Element action

• --maxrc (number)

  • The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

    Default value: 8

• --instance | -i (string)

  • Specifies Endevor Web Services dataSource name.

input sources options

• --from-file | --ff (string)

  • Use this input to provide source file.

• --from-dataset | --fd (string)

  • Use this input to provide source data set name.

• --from-member | --fm (string)

  • Use this input to provide source member name in the data set.

• --from-path | --fp (string)

  • Use this input to provide the path of source USS file. It must be used with from-uss-file.

• --from-uss-file | --fuf (string)

  • Use this input to provide source USS file name. It must be used with from-path

options

• --override-signout | --os (boolean)

  • Specify if you want to override the Signout of an Endevor element while performing this action.

• --new-version | --nv (number)

  • Assign a different version number to the Element.

• --proc-group | --pg (string)

  • The Endevor processor group you would like to use.

• --generate | -g (boolean)

  • Specifies if you want to Generate Element after Add/Update action.

• --get-fingerprint | --gfg (boolean)

  • Return fingerprint of a retrieved, added or updated element as the first line of the response.

    Default value: false

• --fingerprint | --fg (string)

  • Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet.

• --charset | --char (string)

  • Specifies the clients preferred character set when retrieving, printing or updating elements.

    Default value: false

endevor session definition options

• --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

output customization options

• --suppress-messages | --sm (boolean)

  • Suppress all [INFO]/[WARN] messages from terminal output.

• --report-file | --file-name (string)

  • File name for saving reports from Endevor SCM locally.

• --report-dir (string)

  • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.

• --write-report (boolean)

  • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false

Profile Options

• --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.

Base Connection Options

• --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.

    Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Add element from local file with endevor profile set up:

  • zowe endevor add element elementName --env ENV --sys SYS --sub SUB --typ TYPE --ff localfile.txt -i ENDEVOR --ccid CCID --comment 'adding element' Copy