@zowe/cli
Version:
Zowe CLI is a command line interface (CLI) that provides a simple and streamlined way to interact with IBM z/OS.
74 lines • 3.11 kB
JavaScript
;
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/
Object.defineProperty(exports, "__esModule", { value: true });
exports.CommandDefinition = void 0;
const zos_tso_for_zowe_sdk_1 = require("@zowe/zos-tso-for-zowe-sdk");
exports.CommandDefinition = {
name: "command",
aliases: ["cmd"],
summary: "Issue a TSO command",
description: "Creates a TSO address space, issues a TSO command through the newly created address space, " +
"waits for the READY prompt to print the response, and terminates the TSO address space. All response data" +
" is returned to the user up to (but not including) the TSO 'READY' prompt.",
type: "command",
handler: __dirname + "/Command.handler",
profile: {
optional: ["zosmf", "tso"],
},
positionals: [
{
name: "commandText",
type: "string",
description: "The TSO command to issue.",
required: true,
},
],
options: [
{
// Old API behavior will be utilized upon specifying --legacy true, or --ssm to be false,
// otherwise try new API and if it fails, fallback to old API.
// Specifying --ssm to be false makes the value of --stateful have no impact on
// behavior since old API behavior does not utilize statefulness.
name: "suppress-startup-messages",
aliases: ["ssm"],
type: "boolean",
description: "Suppress console messages from start of address space.",
defaultValue: true,
},
{
// --stateful has no impact if --suppress-startup-messages is set to false.
name: "stateful",
aliases: ["sf"],
type: "boolean",
description: "Statefulness of address space created for TSO command." +
" This option is not supported when --suppress-startup-messages is set to false.",
defaultValue: false,
},
{
name: "legacy",
aliases: [],
type: "boolean",
description: "Force the use of the previous TSO command functionality " +
"(where Zowe CLI creates and tears down the TSO address space via multiple API calls)." +
" This is useful for working around an issue that might occur when using the newer z/OSMF API where an error " +
"reading 'Did not receive output from the z/OSMF TSO API' is thrown.",
defaultValue: false,
},
].concat(zos_tso_for_zowe_sdk_1.TsoProfileConstants.TSO_PROFILE_OPTIONS),
examples: [
{
description: 'Issue the TSO command "status" to display information about jobs for your user ID.',
options: '"status"',
},
],
};
//# sourceMappingURL=Command.definition.js.map