zowe › endevor › transfer › element🖨️

The Transfer element command transfers Elements from one Endevor location to another.

Usage

zowe endevor transfer 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.

• --stage-number | --sn (string)

  • The Endevor stage number where your project resides.

    Allowed values: 1, 2

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

output location options

• --to-environment | --toenv (string)

  • The target Endevor environment.

• --to-system | --tosys (string)

  • The target Endevor system.

• --to-subsystem | --tosub (string)

  • The target Endevor subsystem.

• --to-element | --toele (string)

  • The target Endevor element name.

• --to-type | --totyp (string)

  • The target Endevor element type.

• --to-stage-number | --tosn (string)

  • The target Endevor stage Id/number.

options

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

  • The Endevor processor group you would like to use.

• --element-version | --ev (number)

  • Indicates the version number of the element (use along with the level option).

• --level | --lev (number)

  • Indicates the level number of the element (use along with the version option).

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

  • Assign a different version number to the Element.

• --sync | -s (boolean)

  • Specify if you want to synchronize source and current level of the Elements while performing this action.

• --with-history | --wh (boolean)

  • Specify if you want to preserve the change history of the Elements while performing this action.

• --ignore-generate-failed | --igf (boolean)

  • Process the transfer request regardless of whether the FAILED flag is set for the element or if the element was generated or moved successfully.

• --bypass-element-delete | --bed (boolean)

  • Specify if you want to retain the Elements in the source Stage after successfully completing this action.

• --bypass-delete-proc | --bdp (boolean)

  • Specity to bypasses the execution of the delete processor.

• --bypass-generate-proc | --bgp (boolean)

  • Specify to bypasses the execution of the generate or move processor (whichever may be chosen) upon element transfer.

• --retain-signout | --rs (boolean)

  • Specify if you want to retain the source location signouts for all Elements at the target location while performing this action.

• --signout-to | --st (string)

  • Specify if you want to sign all Elements out to the specified user ID at the target Stage while performing this action.

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

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

• --where-proc-group | --wpg (string)

  • Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
    Accepts up to 8 Processor group names separated by ", ".

• --where-ccid-all | --wca (string)

  • Instructs Endevor to search both the Master Control File and the SOURCE DELTA levels for a specified CCIDs.
    Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.

• --where-ccid-current | --wcc (string)

  • Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
    Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.

• --where-ccid-retrieve | --wcr (string)

  • Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
    Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.

asynchronous task options

• --asynchronous | --async (boolean)

  • Submit this command as an asynchronous Endevor Web Services task

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

• Transfer element from specified inventory location to 1 stage higher in map, with endevor profile set up:

  • zowe endevor transfer element elementName --env ENV --sn 1 --tosn 2 --sys SYS --sub SUB --typ TYPE -i ENDEVOR Copy