diff --git a/commandGroups/rse-api-for-zowe-cli.jsonc b/commandGroups/rse-api-for-zowe-cli.jsonc new file mode 100644 index 0000000..d708a13 --- /dev/null +++ b/commandGroups/rse-api-for-zowe-cli.jsonc @@ -0,0 +1,13138 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-api-for-zowe-cli", + "description": "Welcome to the IBM RSE API Plug-in for Zowe CLI!\n\n", + "type": "group", + "children": [ + { + "name": "auth", + "summary": "Connect to RSE API Server Authentication Service", + "description": "Connect to the RSE API Server authentication service and obtain a token. The token provides authentication to services that are supported by the RSE API. When you log in, the token is stored in your profile until it expires. Profiles store connection information, and are used if you do not supply connection information in a command. To take advantage of the token authentication service, you should omit username and password in profiles so that the token in the profile is used.", + "type": "group", + "children": [ + { + "name": "login", + "aliases": [ + "li" + ], + "summary": "Log in to an authentication service to obtain a JWT Token.", + "description": "Log in to an authentication service to obtain a JWT Token.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "Obtain token by logging into an authentication service if username and password are not saved locally.", + "options": "--user IBMUSER --password PASSWORD" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "refreshToken", + "aliases": [ + "rt" + ], + "summary": "Refresh the current session and obtain a newer JWT Token.", + "description": "Refresh the current session and obtain a newer JWT Token.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "Extend a remote session beyond the timeout period of a JWT token.", + "options": " (after login)" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "logout", + "aliases": [ + "lo" + ], + "summary": "Log out of the authentication service and retire the JWT Token", + "description": "Log out of the authentication service and retire the JWT Token", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "query", + "aliases": [ + "q" + ], + "summary": "Get back JWT Token information if it is not yet expired.", + "description": "Get back JWT Token information if it is not yet expired.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "cancel", + "aliases": [ + "can" + ], + "type": "group", + "summary": "Cancel a job", + "description": "Cancel a single job by job ID. This cancels the job if it is running or on input.", + "children": [ + { + "name": "job", + "type": "command", + "summary": "Cancel a single job by job ID", + "description": "Cancel a single job by job ID", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example \"J123\".", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Cancel job with job ID JOB03456", + "options": "JOB03456" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "aliases": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "change", + "summary": "Change User Data on the Host", + "description": "Change User Data on the Host", + "type": "group", + "children": [ + { + "name": "password", + "aliases": [ + "pass" + ], + "summary": "Change z/OS User Password on the Host. User will be prompted for user name, password, and new password.", + "description": "Change z/OS User Password on the Host. User will be prompted for user name, password, and new password.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "currentPassword", + "description": "Current password for z/OS User ID.", + "type": "string", + "required": false + }, + { + "name": "newPassword", + "description": "New password for z/OS User ID. Must be 8 characters or less.", + "type": "string", + "required": false + } + ], + "examples": [ + { + "description": "Change Password", + "options": "currentPassword newPassword" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "properties", + "aliases": [ + "prop" + ], + "summary": "Change owner and permissions for a unix file", + "description": "Change owner and permissions for a unix file", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "file", + "description": "the file that will have its properties changed.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "owner", + "aliases": [ + "o" + ], + "description": "the new owner for the file.", + "type": "string", + "required": false, + "group": "Options" + }, + { + "name": "group", + "aliases": [ + "g" + ], + "description": "the new group for the file.", + "type": "string", + "required": false, + "group": "Options" + }, + { + "name": "permissions", + "aliases": [ + "p" + ], + "description": "the new permissions for the file.", + "type": "string", + "required": false, + "group": "Options" + }, + { + "name": "tag", + "aliases": [ + "t" + ], + "description": "the new tag for the file", + "type": "string", + "required": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Change Properties", + "options": "'/u/example/file123.txt' --owner exampleOwner --group exampleGroup --permission rwxrwxrwx --tag utf8" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "check", + "summary": "Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes, and information about user password expiry. Obtain and update MVS mappings file", + "description": "Confirm that RSE API is running on a specified system and gather information about the RSE API server and Address Space for diagnostic purposes, and information about user password expiry. Obtain and update MVS mappings file", + "type": "group", + "children": [ + { + "name": "status", + "summary": "Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.", + "description": "Confirm that RSE API is running on a system specified in your profile and gather information about the RSE API server for diagnostic purposes. The command outputs properties of the RSE API server such as version, hostname, and the port the server is running.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "aliases": [], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "conversion-mappings", + "aliases": [ + "maps" + ], + "summary": "Download MVS mapping file.", + "description": "Download MVS mapping file.", + "type": "command", + "handler": "", + "options": [ + { + "name": "force", + "description": "This will overwrite an existing rse-mappings.json file.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "system-address-space", + "aliases": [ + "sys" + ], + "summary": "Display active system address space information.", + "description": "Display active system address space information.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "job-address-space", + "aliases": [ + "jobs" + ], + "summary": "Display all active job address space information.", + "description": "Display all active job address space information.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "asid", + "description": "Address space identifier.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "asidx", + "description": "Address space identifier in hexadecimal.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "bytes", + "description": "Current real storage usage in bytes.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "cpu", + "description": "Accumulated CPU time consumed by and on behalf of and within the A/S, for the current job step, in microseconds (local + remote + external).", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "cpu%", + "description": "Percent of all CPU time consumed by and on behalf of the address space during the most recent interval measured.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "description", + "description": "Address space position description.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "dp", + "description": "Address space dispatching priority in hexadecimal.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "elapsed", + "description": "Elapsed time the transaction has been active.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "frames", + "description": "Current utilization of real storage in frames.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "hvcomhwm", + "description": "High virtual common memory high-water mark in MB.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "hvcomused", + "description": "High virtual common memory size in MB.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "io", + "description": "EXCP rate in EXCPs per second for address space.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "name", + "description": "Job name.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "page", + "description": "Demand paging rate for address space.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "position", + "description": "Address space position.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "stepIO", + "description": "A/S EXCP (I/O) count for the current job step.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "subtype", + "description": "Sub-type of 1.job/initiator: JES, z/OS UNIX, or APPC, 2.started task: JES, MSTR, SYS.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "swapin", + "description": "Swapped-in state.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "sysName", + "description": "System name where job is executing.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "task", + "description": "A/S CPU usage % of system total in interval - task (local + remote).", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "task%", + "description": "Accumulated CPU time consumed by and on behalf of the A/S, for the current job step, in microseconds (local + remote).", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "type", + "description": "Type of address space.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "userId", + "description": "User id of owner.", + "type": "boolean", + "group": "Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Display all active job address space information using filters for information to be shown", + "options": "--asid --dp" + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "password-expiry", + "aliases": [ + "expiry" + ], + "summary": "Displays expiration date of user id's password.", + "description": "Displays expiration date of user id's password.", + "type": "command", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "common-properties", + "aliases": [ + "cm" + ], + "summary": "Manage Common Properites", + "description": "Manage Common Properties on z/OS RSE API server.", + "type": "group", + "children": [ + { + "name": "copy", + "aliases": [ + "cp" + ], + "summary": "Copy a namespace", + "description": "Copy a Common Properties namespace.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "fromNamespaceName", + "type": "string", + "description": "The name of the Common Properties namespace that you want to copy from.", + "required": true + }, + { + "name": "toNamespaceName", + "type": "string", + "description": "The name of the Common Properties namespace that you want to copy to.", + "required": true + } + ], + "options": [ + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "copy a public namespace", + "options": "my-namespace your-namespace" + }, + { + "description": "copy a private namespace", + "options": "my-namespace your-namespace --private" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "create", + "aliases": [ + "cre" + ], + "summary": "Create a namespace", + "description": "Create a Common Properties namespace.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "namespaceName", + "type": "string", + "description": "The name of the Common Properties namespace.", + "required": true + } + ], + "options": [ + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "Create a public namespace called \"global-namespace\"", + "options": "\"global-namespace\"" + }, + { + "description": "Create a user private namespace called \"private-namespace\"", + "options": "\"private-namespace\" --private" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "delete", + "aliases": [ + "del" + ], + "summary": "Delete the namespace or a property in the namespace", + "description": "Delete the namespace or a property in the namespace if --path option is specified.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "namespaceName", + "type": "string", + "description": "The name of the Common Properties namespace.", + "required": true + } + ], + "options": [ + { + "name": "path", + "aliases": [ + "p" + ], + "description": "The path to the property in the Common Properties namespace.", + "type": "string", + "group": "Options" + }, + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "Delete a private namespace", + "options": "\"private-namespace\" --private" + }, + { + "description": "Detete a property in a namespace", + "options": "\"global-namespace\" -p /root/portnumber" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "list", + "aliases": [ + "ls" + ], + "summary": "List all namespaces", + "description": "List all public or private Common Properties namespaces.", + "type": "command", + "handler": "", + "options": [ + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "list all public Common Properties namespaces", + "options": "" + }, + { + "description": "list all private Common Properties namespaces", + "options": "--private" + } + ], + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "rename", + "aliases": [], + "summary": "Rename a namespace", + "description": "Rename a Common Properties namespace.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "beforeNamespaceName", + "type": "string", + "description": "The name of the Common Properties namespace that you want to rename.", + "required": true + }, + { + "name": "afterNamespaceName", + "type": "string", + "description": "The name you want to rename the Common Properties namespace to.", + "required": true + } + ], + "options": [ + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "rename a public namespace", + "options": "my-namespace your-namespace" + }, + { + "description": "rename a private namespace", + "options": "my-namespace your-namespace --private" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "set", + "aliases": [], + "summary": "Set a namespace property", + "description": "Set a namespace property with a string, boolean, number or JSON string value.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "namespaceName", + "type": "string", + "description": "The name of the Common Properties namespace.", + "required": true + }, + { + "name": "propertyPath", + "type": "string", + "description": "The path to the property in the Common Properties namespace.", + "required": true + }, + { + "name": "propertyValue", + "type": "string", + "description": "The property value.", + "required": true + } + ], + "options": [ + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "value-type", + "aliases": [ + "type" + ], + "description": "The property value type (string, number, boolean, json)", + "type": "string", + "defaultValue": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "set a string value to a property", + "options": "my-namespace /server/hostname www.host.com " + }, + { + "description": "set a number value to a property", + "options": "my-namespace /server/port 1234 --type number" + }, + { + "description": "set a JSON value to a property", + "options": "my-namespace /server '{\"hostname\" : \"www.host.com\", \"port\" : 1234}' --type json" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "view", + "aliases": [ + "vw" + ], + "summary": "View the namespace or a property in the namespace", + "description": "View the namespace or a property in the namespace if --path option is specified.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "namespaceName", + "type": "string", + "description": "The name of the Common Properties namespace.", + "required": true + } + ], + "options": [ + { + "name": "path", + "aliases": [ + "p" + ], + "description": "The path to the property in the Common Properties namespace.", + "type": "string", + "defaultValue": "/", + "group": "Options" + }, + { + "name": "private", + "aliases": [], + "description": "The namespace is a private Common Properties namespace if specified.", + "type": "boolean", + "defaultValue": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "View a property at the path in a private namespace", + "options": "my-namespace --path /hostname --private" + }, + { + "description": "View all properties in a public namespace", + "options": "my-namespace" + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "copy", + "summary": "Copy a z/OS UNIX System Services file/directory or data set", + "description": "Copy a z/OS UNIX System Services file/directory or data set", + "type": "group", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "summary": "Copy a data set to another data set", + "description": "Copy a data set to another data set", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "fromDataSetName", + "description": "The name of the data set that you want to copy from", + "type": "string", + "required": true + }, + { + "name": "toDataSetName", + "description": "The name of the data set that you want to copy to (partitioned data set must be preallocated to copy a member to)", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Copy the data set member named 'USER.FROM.SET(MEM1)' to the data set member named 'USER.TO.SET(MEM2)'", + "options": "\"USER.FROM.SET(mem1)\" \"USER.TO.SET(mem2)\"" + }, + { + "description": "Copy the sequential data set named 'USER.FROM.PDSE' to the data set member named 'USER.TO.SETPDSE'", + "options": "\"USER.FROM.PDSE\" \"USER.TO.SETPDSE\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "uss-file", + "aliases": [ + "uss" + ], + "summary": "Copy a z/OS UNIX System Services file/directory to another directory", + "description": "Copy a z/OS UNIX System Services file/directory to another directory", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "path", + "description": "The working directory", + "type": "string", + "required": true + }, + { + "name": "destination", + "description": "The destination path of the new file to be appended to the parent path", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Copy the file named '/u/example1/test.txt' to the destination '/u/example2/test.txt'", + "options": "\"/u/example1/test.txt\" \"/u/example2/test.txt\"" + }, + { + "description": "Copy the directory named '/u/example1' to the destination '/u/example2'", + "options": "\"/u/example1\" \"/u/example2\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "create", + "aliases": [ + "cre" + ], + "summary": "Create data sets", + "description": "Create data sets, data set members or z/OS UNIX System Services files and directories", + "type": "group", + "children": [ + { + "name": "data-set-partitioned", + "aliases": [ + "pds" + ], + "description": "Create partitioned data sets (PDS)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set that you want to create", + "required": true + } + ], + "options": [ + { + "name": "allocation-unit", + "aliases": [ + "au" + ], + "description": "The allocation unit (for example, CYL for Cylinders)", + "type": "string", + "defaultValue": "TRACK", + "group": "Options" + }, + { + "name": "average-blocks", + "aliases": [ + "ab" + ], + "description": "The number of average blocks (for example, 25)", + "type": "number", + "group": "Options" + }, + { + "name": "block-size", + "aliases": [ + "bs", + "blksize" + ], + "description": "The block size for the data set (for example, 6160)", + "type": "number", + "defaultValue": 6160, + "group": "Options" + }, + { + "name": "data-set-type", + "aliases": [ + "dst", + "dsntype" + ], + "description": "The data set type", + "type": "string", + "group": "Options" + }, + { + "name": "device-type", + "aliases": [ + "dt" + ], + "description": "The device type, also known as 'unit'", + "type": "string", + "group": "Options" + }, + { + "name": "directory-blocks", + "aliases": [ + "db", + "dirblks" + ], + "description": "The number of directory blocks (for example, 25)", + "type": "number", + "defaultValue": 5, + "group": "Options" + }, + { + "name": "primary-space", + "aliases": [ + "ps" + ], + "description": "The primary space allocation (for example, 5)", + "type": "number", + "defaultValue": 1, + "group": "Options" + }, + { + "name": "record-format", + "aliases": [ + "rf", + "recfm" + ], + "description": "The record format for the data set (for example, FB for \"Fixed Block\")", + "type": "string", + "defaultValue": "FB", + "group": "Options" + }, + { + "name": "record-length", + "aliases": [ + "rl", + "lrecl" + ], + "description": "The logical record length. Analogous to the length of a line (for example, 80)", + "type": "number", + "defaultValue": 80, + "group": "Options" + }, + { + "name": "secondary-space", + "aliases": [ + "ss" + ], + "description": "The secondary space allocation (for example, 1)", + "type": "number", + "defaultValue": 1, + "group": "Options" + }, + { + "name": "show-attributes", + "aliases": [ + "a", + "pa" + ], + "description": "Show the full allocation attributes", + "type": "boolean", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Create an empty PDS with default parameters", + "options": "NEW.PDS.DATASET" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set-sequential", + "aliases": [ + "ps" + ], + "description": "Create physical sequential data sets (PS)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set that you want to create", + "required": true + } + ], + "options": [ + { + "name": "allocation-unit", + "aliases": [ + "au" + ], + "description": "The allocation unit (for example, CYL for Cylinders)", + "type": "string", + "defaultValue": "CYLINDER", + "group": "Options" + }, + { + "name": "average-blocks", + "aliases": [ + "ab" + ], + "description": "The number of average blocks (for example, 25)", + "type": "number", + "group": "Options" + }, + { + "name": "block-size", + "aliases": [ + "bs", + "blksize" + ], + "description": "The block size for the data set (for example, 6160)", + "type": "number", + "defaultValue": 6160, + "group": "Options" + }, + { + "name": "device-type", + "aliases": [ + "dt" + ], + "description": "The device type, also known as 'unit'", + "type": "string", + "group": "Options" + }, + { + "name": "directory-blocks", + "aliases": [ + "db", + "dirblks" + ], + "description": "The number of directory blocks (for example, 25)", + "type": "number", + "defaultValue": 0, + "group": "Options" + }, + { + "name": "primary-space", + "aliases": [ + "ps" + ], + "description": "The primary space allocation (for example, 5)", + "type": "number", + "defaultValue": 1, + "group": "Options" + }, + { + "name": "record-format", + "aliases": [ + "rf", + "recfm" + ], + "description": "The record format for the data set (for example, FB for \"Fixed Block\")", + "type": "string", + "defaultValue": "FB", + "group": "Options" + }, + { + "name": "record-length", + "aliases": [ + "rl", + "lrecl" + ], + "description": "The logical record length. Analogous to the length of a line (for example, 80)", + "type": "number", + "defaultValue": 80, + "group": "Options" + }, + { + "name": "secondary-space", + "aliases": [ + "ss" + ], + "description": "The secondary space allocation (for example, 1)", + "type": "number", + "defaultValue": 1, + "group": "Options" + }, + { + "name": "show-attributes", + "aliases": [ + "a", + "pa" + ], + "description": "Show the full allocation attributes", + "type": "boolean", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Create an empty physical sequential data set with default parameters", + "options": "NEW.PS.DATASET" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "uss-file", + "aliases": [ + "file" + ], + "description": "Create a z/OS UNIX System Services file.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "ussPath", + "type": "string", + "description": "The name of the file.", + "required": true + } + ], + "options": [ + { + "name": "mode", + "type": "string", + "description": "File permissions, ex. `rwxrw-r--`", + "defaultValue": "rwxrw-r--", + "group": "Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Create a z/OS UNIX System Services file named \"test.ext\" ", + "options": "file.txt" + }, + { + "description": "Create a z/OS UNIX System Services file named \"text.txt\" with mode \"rwxrwxrwx\" ", + "options": "file.txt -m rwxrwxrwx" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "uss-directory", + "aliases": [ + "dir" + ], + "description": "Create a z/OS UNIX System Services directory.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "ussPath", + "type": "string", + "description": "The name of the directory.", + "required": true + } + ], + "options": [ + { + "name": "mode", + "type": "string", + "description": "Directory permissions, ex. `rwxrw-r--`", + "defaultValue": "rwxrw-r--", + "group": "Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Create a z/OS UNIX System Services directory named \"testDir\" ", + "options": "testDir" + }, + { + "description": "Create a z/OS UNIX System Services directory named \"testDir\" with mode \"rwxrwxrwx\" ", + "options": "testDir -m rwxrwxrwx" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set-member", + "aliases": [ + "member" + ], + "description": "Create a member for a Partitioned data set.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "datasetMember", + "type": "string", + "description": "The name of the data set member that you want to create like so \"HLQ.DATASETNAME(NEWMEMBER)\".", + "required": true + } + ], + "examples": [ + { + "description": "Create a new, empty member for a PDS.", + "options": "\"HLQ.DATASETNAME(NEWMEMBER)\"" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set", + "aliases": [ + "ds" + ], + "description": "Create a data set based on the properties of an existing data set", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set that you want to create", + "required": true + } + ], + "options": [ + { + "name": "allocation-unit", + "aliases": [ + "au" + ], + "description": "The allocation unit (for example, CYL for Cylinders)", + "type": "string", + "group": "Options" + }, + { + "name": "average-blocks", + "aliases": [ + "ab" + ], + "description": "The number of average blocks (for example, 25)", + "type": "number", + "group": "Options" + }, + { + "name": "block-size", + "aliases": [ + "bs", + "blksize" + ], + "description": "The block size for the data set (for example, 6160)", + "type": "number", + "group": "Options" + }, + { + "name": "device-type", + "aliases": [ + "dt" + ], + "description": "The device type, also known as 'unit'", + "type": "string", + "group": "Options" + }, + { + "name": "directory-blocks", + "aliases": [ + "db", + "dirblks" + ], + "description": "The number of directory blocks (for example, 25)", + "type": "number", + "group": "Options" + }, + { + "name": "like", + "aliases": [ + "lk" + ], + "description": "Name of an existing data set to base your new data set's properties on", + "type": "string", + "group": "Options" + }, + { + "name": "primary-space", + "aliases": [ + "ps" + ], + "description": "The primary space allocation (for example, 5)", + "type": "number", + "group": "Options" + }, + { + "name": "record-format", + "aliases": [ + "rf", + "recfm" + ], + "description": "The record format for the data set (for example, FB for \"Fixed Block\")", + "type": "string", + "group": "Options" + }, + { + "name": "record-length", + "aliases": [ + "rl", + "lrecl" + ], + "description": "The logical record length. Analogous to the length of a line (for example, 80)", + "type": "number", + "group": "Options" + }, + { + "name": "secondary-space", + "aliases": [ + "ss" + ], + "description": "The secondary space allocation (for example, 1)", + "type": "number", + "group": "Options" + }, + { + "name": "show-attributes", + "aliases": [ + "a", + "pa" + ], + "description": "Show the full allocation attributes", + "type": "boolean", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Create a data set with default parameters and like flag", + "options": "NEW.DATASET --like EXISTING.DATASET" + }, + { + "description": "Create a data set with default parameters, like flag, and lrecl flag", + "options": "NEW.DATASET --like EXISTING.DATASET --lrecl 1024" + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "delete", + "aliases": [ + "del" + ], + "type": "group", + "description": "Delete a data set or Unix System Services file", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "description": "Delete a data set permanently", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set that you want to delete", + "required": true + } + ], + "examples": [ + { + "description": "Delete the data set named 'ibmuser.cntl'", + "options": "\"ibmuser.cntl\"" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "uss-file", + "aliases": [ + "uss" + ], + "description": "Delete a z/OS UNIX System Services file or directory permanently", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "fileName", + "type": "string", + "description": "The name of the file or directory that you want to delete", + "required": true + } + ], + "examples": [ + { + "description": "Delete the directory '/u/ibmuser/testcases'", + "options": "\"/a/ibmuser/testcases\"" + }, + { + "description": "Delete the file named '/a/ibmuser/my_text.txt'", + "options": "\"/a/ibmuser/testcases/my_text.txt\"" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "job", + "aliases": [ + "js" + ], + "type": "command", + "summary": "Delete a single job by job ID", + "description": "Delete a single job by job ID", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows you to abbreviate the job ID if desired. You can use, for example \"J123\".", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Delete job with job ID JOB03456.", + "options": "JOB03456" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "download", + "aliases": [ + "dl" + ], + "type": "group", + "summary": "Download content from z/OS data sets, UNIX System Services files, and JOB Output to your PC.", + "description": "Download content from z/OS data sets, UNIX System Services files, and JOB Output to your PC.", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "summary": "Download content from a z/OS data set", + "description": "Download content from a z/OS data set to a local file", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "description": "The name of the data set that you want to download", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "Save the local files with a specified file extension. For example, .txt. Or \"\" for no extension. When no extension is specified, .txt is used as the default file extension.", + "type": "stringOrEmpty", + "group": "Options" + }, + { + "name": "file", + "aliases": [ + "f" + ], + "description": "The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.", + "type": "string", + "group": "Options" + }, + { + "name": "mappings-file", + "aliases": [ + "maps" + ], + "description": "Location of an alternate MVS Mappings file.", + "type": "string", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Download the data set \"ibmuser.loadlib(main)\" to the local file \"main.obj\".", + "options": "\"ibmuser.loadlib(main)\" -f main.obj" + }, + { + "description": "Download the data set \"ibmuser.loadlib(main)\" to the local file \"main.obj\" in binary mode.", + "options": "\"ibmuser.loadlib(main)\" -b \"./main.obj\"" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "all-members", + "aliases": [ + "am" + ], + "summary": "Download all members from a pds", + "description": "Download all members from a partitioned data set to a local folder", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "description": "The name of the data set from which you want to download members", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "directory", + "aliases": [ + "d" + ], + "description": "The directory to where you want to save the members. The command creates the directory for you when it does not already exist. By default, the command creates a folder structure based on the data set qualifiers. For example, the data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).", + "type": "string", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "Save the local files with a specified file extension. For example, .txt. Or \"\" for no extension. When no extension is specified, .txt is used as the default file extension.", + "type": "stringOrEmpty", + "group": "Options" + }, + { + "name": "mappings-file", + "aliases": [ + "maps" + ], + "description": "Location of an alternate MVS Mappings file.", + "type": "string", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Download the members of the data set \"ibmuser.loadlib\" to the directory \"loadlib/\"", + "options": "\"ibmuser.loadlib\" -d loadlib" + }, + { + "description": "Download the members of the data set \"ibmuser.cntl\" as a .jcl to the directory \"jcl/\"", + "options": "\"ibmuser.cntl\" -e .jcl -d jcl" + }, + { + "description": "Download the members of the data set \"ibmuser.cntl\" as binary.", + "options": "\"ibmuser.cntl\" -b" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "uss-file", + "aliases": [ + "uf" + ], + "summary": "Download content from a z/OS UNIX System Services file", + "description": "Download content from a z/OS UNIX System Services file to a local file on your PC", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "ussFileName", + "description": "The name of the z/OS UNIX System Services file you want to download", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process returns each line as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "file", + "aliases": [ + "f" + ], + "description": "The path to the local file where you want to download the content. When you omit the option, the command generates a file name automatically for you.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Download the file \"/a/ibmuser/my_text.txt\" to \"./my_text.txt\"", + "options": "\"/a/ibmuser/my_text.txt\" -f \"./my_text.txt\"" + }, + { + "description": "Download the file \"/a/ibmuser/my_text.txt\" to \"./my_text.txt\" in binary mode", + "options": "\"/a/ibmuser/my_text.txt\" -b -f \"./my_text.txt\"" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "output", + "aliases": [ + "o" + ], + "type": "command", + "summary": "Download all job output to a directory", + "description": "Download all job output to a local directory. Each spool DD will be downloaded to its own file in the directory.", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The z/OS JOBID of the job containing the spool files you want to view. No pre-validation of the JOBID is performed.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "directory", + "aliases": [ + "d", + "dir" + ], + "description": "The local directory you would like to download the output for the job to.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "A file extension to save the job output with. Defaults to '.txt'.", + "type": "string", + "group": "Options" + }, + { + "name": "omit-jobid-directory", + "aliases": [ + "ojd" + ], + "description": "If specified, job output will be saved directly to the specified directory rather than creating a subdirectory named after the ID of the job.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Download all the output of the job with job ID JOB00234 to an automatically generated directory.", + "options": "JOB00234" + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "export", + "summary": "Export Z/OS files.", + "description": "Export Z/OS files.", + "type": "group", + "children": [ + { + "name": "spool-file", + "aliases": [ + "spool", + "sf" + ], + "summary": "Export a JES job provided job name, ID, fileID, and MVS data set.", + "description": "Export a JES job provided job name, ID, fileID, and MVS data set.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "jobName", + "description": "Job Name", + "type": "string", + "required": true + }, + { + "name": "jobId", + "description": "Job Id", + "type": "string", + "required": true + }, + { + "name": "spoolFileId", + "description": "Spool Id", + "type": "number", + "required": true + }, + { + "name": "toDataSetName", + "description": "MVS data set name to be exported to", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "allow-truncation", + "aliases": [ + "at" + ], + "description": "Allow truncation of the file if record length too small.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Export spool file to sequential data set, 'HLQ.SEQDS'", + "options": "JOBNAME JOBID SPOOLID \"USER.TO.SET\"" + }, + { + "description": "Export spool file a data set member, 'HLQ.DSNAME(MEMBER)'", + "options": "JOBNAME JOBID SPOOLID \"USER.TO.PDS(MEM1)\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "migrate", + "aliases": [ + "hmigr", + "hMigrate" + ], + "type": "group", + "description": "Migrate data sets.", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "description": "Migrate a data set.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set you want to migrate.", + "required": true + } + ], + "examples": [ + { + "description": "Migrate a data set using default options", + "options": "\"USER.DATA.SET\"" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "recall", + "aliases": [ + "hrec", + "hRecall" + ], + "type": "group", + "description": "Recall migrated data sets.", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "description": "Recall a migrated data set.", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "dataSetName", + "type": "string", + "description": "The name of the data set you want to recall.", + "required": true + } + ], + "examples": [ + { + "description": "Recall a data set using default options", + "options": "\"USER.DATA.SET\"" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "issue", + "summary": "Issue TSO and UNIX commands", + "description": "Issue TSO and UNIX commands", + "type": "group", + "children": [ + { + "name": "command", + "aliases": [ + "cmd", + "tso" + ], + "summary": "Issue a TSO command, only supported in RSE API v1.0.1 and higher", + "description": "Creates a TSO address space, issues a TSO command through the newly createdaddress space, waits for the READY prompt to print the response, and terminatesthe TSO address space. All response data are returned to the user up to (but notincluding) the TSO 'READY' prompt.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "commandText", + "description": "The TSO command to issue.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "shell-id", + "aliases": [ + "id" + ], + "description": "Specify this if you wish to reuse a shell. Required for interactive TSO commands.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Issue the TSO command \"status\" to display information about jobs for your user ID", + "options": "\"status\"" + }, + { + "description": "Issue an interactive TSO command with shell-id.", + "options": "\"TSO EX 'HLQ.REXX(REXPROG)'\" --shell-id myshell" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "unix", + "aliases": [ + "uss" + ], + "summary": "Issue a UNIX command", + "description": "issues a UNIX command", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "commandText", + "description": "The UNIX command to issue.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "cwd", + "description": "Working directory in which to execute the command.", + "type": "string", + "required": true, + "group": "Required Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Issue the UNIX command \"ls\" to display a list of items in the directory", + "options": "\"ls\" --cwd \"/u/ibmuser\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "unix-shell", + "aliases": [ + "unix-streaming", + "uss-shell" + ], + "summary": "Issue a UNIX shell command with streaming output", + "description": "issue a UNIX shell command with streaming output", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "commandText", + "description": "The UNIX command to issue.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "cwd", + "description": "Working directory in which to execute the command.", + "type": "string", + "required": true, + "group": "Required Options", + "aliases": [] + }, + { + "name": "env", + "description": "A comma-separated list of environment variables to be set in the executing shell.", + "type": "string", + "required": false, + "group": "Options", + "aliases": [] + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Issue the UNIX command to display the content of a file.", + "options": "'cat $logfile' --cwd '/u/ibmuser' --env 'logfile=output.log'" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "aliases": [], + "positionals": [], + "passOn": [] + }, + { + "name": "list", + "aliases": [ + "ls" + ], + "summary": "List the details for data sets and the members in the data sets, z/OS UNIX System Services files and directories, and jobs and spool files.", + "description": "List z/OS UNIX System Services file and folders, data sets and data set members, or jobs and spool files. Optionally, you can list their details and attributes.", + "type": "group", + "children": [ + { + "name": "uss-files", + "aliases": [ + "uss" + ], + "summary": "List z/OS UNIX System Services files", + "description": "List z/OS UNIX System Services files and directories in a UNIX file path", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "path", + "description": "The directory containing the files and directories to be listed", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Show the files and directories in path '/u/ibmuser'", + "options": "\"/u/ibmuser\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "outputFormatOptions": true, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set", + "aliases": [ + "ds" + ], + "summary": "List data sets", + "description": "List data sets that match a pattern in the data set name", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "filter", + "description": "The name or pattern of the data set that you want to list", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "attributes", + "aliases": [ + "a" + ], + "description": "Display more information about each member. Data sets with an undefined record format display information related to executable modules. Variable and fixed block data sets display information about when the members were created and modified.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Show the data set \"ibmuser.asm\"", + "options": "\"ibmuser.asm\"" + }, + { + "description": "Show attributes of the data set \"ibmuser.cntl\"", + "options": "\"ibmuser.cntl\" -a" + }, + { + "description": "Show all data sets of the user \"ibmuser\"", + "options": "\"ibmuser.*\"" + }, + { + "description": "Show attributes of all data sets of the user \"ibmuser\"", + "options": "\"ibmuser.*\" -a" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "all-members", + "aliases": [ + "am" + ], + "summary": "List all members of a pds", + "description": "List all members of a partitioned data set. To view additional information about each member, use the --attributes option under the Options section of this help text.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "dataSetName", + "description": "The name of the data set for which you want to list the members", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "pattern", + "aliases": [ + "p" + ], + "description": "Pattern for member filter search.", + "type": "string", + "group": "Options" + }, + { + "name": "attributes", + "aliases": [ + "a" + ], + "description": "Display more information about each member.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Show members of the data set \"ibmuser.asm\"", + "options": "\"ibmuser.asm\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "jobs", + "aliases": [ + "js" + ], + "summary": "List z/OS jobs on JES spool/queues", + "description": "List jobs on JES spool/queues. By default, the command lists jobs owned (owner) by the user specified in your profile. The default for prefix is \"*\". The default status is ALL. The command does not prevalidate your user ID. The command surfaces errors verbatim from the Jobs REST endpoints.", + "type": "command", + "handler": "", + "options": [ + { + "name": "owner", + "aliases": [ + "o" + ], + "description": "Specify the owner of the jobs you want to list. The owner is the individual/user who submitted the job OR the user ID assigned to the job. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form \"USER*\".", + "type": "string", + "group": "Options" + }, + { + "name": "prefix", + "aliases": [ + "p" + ], + "description": "Specify the job name prefix of the jobs you want to list. The command does not prevalidate the owner. You can specify a wildcard according to the Jobs REST endpoint documentation, which is usually in the form \"JOB*\".", + "type": "string", + "group": "Options" + }, + { + "name": "status", + "aliases": [ + "s" + ], + "description": "Specify if you want to list ALL jobs or only ACTIVE, OUTPUT, or INPUT jobs.", + "type": "string", + "group": "Options" + }, + { + "name": "attributes", + "aliases": [ + "a" + ], + "description": "Display more information about each job.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "examples": [ + { + "description": "List all jobs with default settings. The command returns jobs owned by your user ID with any job name", + "options": "" + }, + { + "description": "List all ACTIVE jobs owned by user IDs starting with 'ibmu' and job names starting with 'myjo'", + "options": "-o \"ibmu*\" -p \"myjo*\" -s \"ACTIVE\"" + }, + { + "description": "List all jobs with default owner and prefix settings, displaying only the job ID of each job", + "options": "--rff jobid --rft table" + } + ], + "outputFormatOptions": true, + "positionals": [], + "passOn": [], + "children": [] + }, + { + "name": "spool-files-by-jobid", + "aliases": [ + "sfbj" + ], + "type": "command", + "summary": "List spool files of a z/OS job", + "description": "Given a z/OS job JOBID, list the spool files (DDs) for a z/OS job on the JES/spool queues. The command does not pre-validate the JOBID. The command presents errors verbatim from the RSE API Jobs REST endpoints.", + "handler": "", + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The z/OS JOBID of the job with the spool files you want to list. No pre-validation of the JOBID is performed.", + "type": "string", + "required": true + } + ], + "outputFormatOptions": true, + "examples": [ + { + "description": "List the spool files of the job with JOBID JOB00123", + "options": "job00123" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "rename", + "aliases": [ + "rn" + ], + "summary": "Rename a Data set, Data set member, File or Directory", + "description": "Rename a Data set, Data set member,File or Directory", + "type": "group", + "children": [ + { + "name": "uss-file", + "aliases": [ + "uss" + ], + "summary": "Rename a z/OS UNIX System Services file or directory.", + "description": "Rename a z/OS UNIX System Services file or directory.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "path", + "description": "Existing z/OS UNIX System Services file or directory Path.", + "type": "string", + "required": true + }, + { + "name": "name", + "description": "New name of z/OS UNIX System Services file or directory.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Rename z/OS UNIX System Services file \"fileName\" to \"newFileName\".", + "options": "\"/u/ibmuser/fileName\" \"newFileName\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set", + "aliases": [ + "ds" + ], + "summary": "Rename a Data Set.", + "description": "Rename a Data Set.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "dataSetName", + "description": "Existing data set name including HLQ.", + "type": "string", + "required": true + }, + { + "name": "name", + "description": "New name of data set", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Rename a Data Set name to a new name.", + "options": "\"hlq.dataSetName\" \"hlq.newDataSetName\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "data-set-member", + "aliases": [ + "member" + ], + "summary": "Rename a Data Set Member.", + "description": "Rename a Data Set Member.", + "type": "command", + "handler": "", + "positionals": [ + { + "name": "dataSetMemberName", + "description": "Existing Data Set Member name including HLQ.", + "type": "string", + "required": true + }, + { + "name": "name", + "description": "New name of data set member", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Rename a Data Set Member name to a new name.", + "options": "\"hlq.dataSetName(memberName)\" \"newMemberName\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "search", + "aliases": [ + "sch" + ], + "type": "group", + "summary": "Search for Unix System Services Files or Data Sets", + "description": "Search by filename, member name, and contents", + "children": [ + { + "name": "uss-file", + "aliases": [ + "uss" + ], + "type": "command", + "summary": "Search for UNIX Files by specifying the path, file name, and text pattern.", + "description": "Search for UNIX Files by specifying the path, file name, and text pattern. If Regex pattern is not used, wildcard patterns are used.", + "handler": "", + "positionals": [ + { + "name": "path", + "description": "The working directory. Example: /u/IBM/test.", + "type": "string", + "required": true + }, + { + "name": "fileName", + "description": "The name of the file to perform the action on. Example: test.txt or ***.txt", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "text", + "description": "The text pattern to be searched for in the provided file. Example: hello", + "type": "string", + "aliases": [ + "t" + ], + "group": "Options" + }, + { + "name": "regex-file-name", + "description": "Regex for filename. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "defaultValue": false, + "aliases": [ + "rfn" + ], + "group": "Options" + }, + { + "name": "regex-content", + "description": "Regex for text pattern. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "defaultValue": false, + "aliases": [ + "rc" + ], + "group": "Options" + }, + { + "name": "case-sensitive-file-name", + "description": "Case-sensitive search for filename", + "type": "boolean", + "defaultValue": false, + "aliases": [ + "csfn" + ], + "group": "Options" + }, + { + "name": "case-sensitive-content", + "description": "Case-sensitive search for content", + "type": "boolean", + "defaultValue": false, + "aliases": [ + "csc" + ], + "group": "Options" + }, + { + "name": "path-results-only", + "description": "Reduce the response to only the path results", + "type": "boolean", + "defaultValue": false, + "aliases": [ + "pro" + ], + "group": "Options" + }, + { + "name": "response-format-type", + "description": "The command response output format type. Must be one of the following: table, list, object, string", + "type": "string", + "aliases": [ + "rft" + ], + "defaultValue": "list", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Search for a Unix System Services file with a file format of *.txt in /u/myuser/myfiles", + "options": "\"/u/ibmuser/\" \"*.txt\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "members", + "aliases": [ + "mem" + ], + "type": "command", + "summary": "Search for PDS member(s)", + "description": "Search for PDS member(s) provided the filter with a member pattern and/or content string.", + "handler": "", + "positionals": [ + { + "name": "filter", + "description": "Dataset filter string. Ex. FILTERNAME.*.", + "type": "string", + "required": true + }, + { + "name": "memberPattern", + "description": "Member name pattern. Ex. MEM or *", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "content", + "description": "Content string to be searched. Ex. HelloWorld or *", + "type": "string", + "aliases": [ + "c" + ], + "group": "Options" + }, + { + "name": "regex-member", + "description": "Regex for member name. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "aliases": [ + "rm" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "regex-content", + "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "aliases": [ + "rc" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "case-sensitive-content", + "description": "Case-sensitive for content", + "type": "boolean", + "aliases": [ + "csc" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "number-of-results", + "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", + "type": "string", + "aliases": [ + "nor" + ], + "group": "Options" + }, + { + "name": "response-format-type", + "description": "The command response output format type. Must be one of the following: table, list, object, string", + "type": "string", + "aliases": [ + "rft" + ], + "defaultValue": "list", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Search for a Dataset Member with a filter of USER.* with member pattern TEST", + "options": "\"USER.*\" \"MEMBER\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "partitioned-dataset", + "aliases": [ + "pds" + ], + "type": "command", + "summary": "Search for partitioned dataset(s)", + "description": "Search for partitioned dataset(s) provided the filter with a dataset name pattern filter.", + "handler": "", + "positionals": [ + { + "name": "filter", + "description": "Dataset filter string. Ex. FILTERNAME.*.", + "type": "string", + "required": true + }, + { + "name": "dsnPattern", + "description": "Dataset name pattern. Ex. HLQ.PDS or *", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "regex-dsn", + "description": "Regex for dataset name. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "aliases": [ + "rd" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "number-of-results", + "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", + "type": "string", + "aliases": [ + "nor" + ], + "group": "Options" + }, + { + "name": "response-format-type", + "description": "The command response output format type. Must be one of the following: table, list, object, string", + "type": "string", + "aliases": [ + "rft" + ], + "defaultValue": "list", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Search for a Partitioned Dataset USER.* with a DSN Pattern of USER.TEST.*", + "options": "\"USER.*\" \"USER.TEST.*\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + }, + { + "name": "sequential-dataset", + "aliases": [ + "seq" + ], + "type": "command", + "summary": "Search for sequential dataset(s)", + "description": "Search for sequential dataset(s) provided the filter with a dataset name pattern and/or content string filter.", + "handler": "", + "positionals": [ + { + "name": "filter", + "description": "Dataset filter string. Ex. FILTERNAME.*.", + "type": "string", + "required": true + }, + { + "name": "dsnPattern", + "description": "Dataset name pattern. Ex. HLQ.PDS or *", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "content", + "description": "Content string to be searched. Ex. HelloWorld or *", + "type": "string", + "aliases": [ + "c" + ], + "group": "Options" + }, + { + "name": "regex-dsn", + "description": "Regex for dataset name. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "aliases": [ + "rd" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "regex-content", + "description": "Regex for content. If Regex pattern is not used, wildcard patterns are used.", + "type": "boolean", + "aliases": [ + "rc" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "case-sensitive-content", + "description": "Case-sensitive for content", + "type": "boolean", + "aliases": [ + "csc" + ], + "defaultValue": false, + "group": "Options" + }, + { + "name": "number-of-results", + "description": "Number of results displayed for MVS search If number-of-results is not used, default is 10000 results.", + "type": "string", + "aliases": [ + "nor" + ], + "group": "Options" + }, + { + "name": "response-format-type", + "description": "The command response output format type. Must be one of the following: table, list, object, string", + "type": "string", + "aliases": [ + "rft" + ], + "defaultValue": "list", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Search for a Sequential Dataset USER.* with a DSN Pattern of USER.TEST.*", + "options": "\"USER.*\" \"USER.TEST.*\"" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "submit", + "aliases": [ + "sub" + ], + "type": "group", + "summary": "Submit z/OS jobs", + "description": "Submit jobs (JCL) contained in data sets.", + "children": [ + { + "name": "data-set", + "aliases": [ + "ds" + ], + "type": "command", + "summary": "Submit a job contained in a data set", + "description": "Submit a job (JCL) contained in a data set. The data set may be of type physical sequential or a PDS member. The command does not pre-validate the data set name. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", + "handler": "", + "positionals": [ + { + "name": "dataset", + "description": "The z/OS data set containing the JCL to submit. You can specify a physical sequential data set (for example, \"DATA.SET\") or a partitioned data set qualified by a member (for example, \"DATA.SET(MEMBER)\"). ", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "view-all-spool-content", + "aliases": [ + "vasc" + ], + "description": "Print all spool output. If you use this option you will wait the job to complete.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-output", + "aliases": [ + "wfo" + ], + "description": "Wait for the job to enter OUTPUT status before completing the command.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-active", + "aliases": [ + "wfa" + ], + "description": "Wait for the job to enter ACTIVE status before completing the command.", + "type": "boolean", + "conflictsWith": [ + "wait-for-output", + "view-all-spool-content", + "directory" + ], + "group": "Options" + }, + { + "name": "directory", + "aliases": [ + "d" + ], + "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "A file extension to save the job output with. Default is '.txt'.", + "type": "string", + "group": "Options" + }, + { + "name": "jcl-symbols", + "aliases": [ + "js" + ], + "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "outputFormatOptions": true, + "examples": [ + { + "options": "\"ibmuser.cntl(deploy)\"", + "description": "Submit the JCL in the data set \"ibmuser.cntl(deploy)\"" + }, + { + "options": "\"ibmuser.cntl(deploy)\" --vasc", + "description": "Submit the JCL in the data set \"ibmuser.cntl(deploy)\", wait for the job to complete and print all output from the job" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "local-file", + "aliases": [ + "lf" + ], + "type": "command", + "summary": "Submit a job contained in a local file", + "description": "Submit a job (JCL) contained in a local file. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", + "handler": "", + "positionals": [ + { + "name": "localFile", + "description": "The local file containing the JCL to submit. ", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "view-all-spool-content", + "aliases": [ + "vasc" + ], + "description": "Print all spool output. If you use this option you will wait the job to complete.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-output", + "aliases": [ + "wfo" + ], + "description": "Wait for the job to enter OUTPUT status before completing the command.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-active", + "aliases": [ + "wfa" + ], + "description": "Wait for the job to enter ACTIVE status before completing the command.", + "type": "boolean", + "conflictsWith": [ + "wait-for-output", + "view-all-spool-content", + "directory" + ], + "group": "Options" + }, + { + "name": "directory", + "aliases": [ + "d" + ], + "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "A file extension to save the job output with. Default is '.txt'.", + "type": "string", + "group": "Options" + }, + { + "name": "jcl-symbols", + "aliases": [ + "js" + ], + "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "outputFormatOptions": true, + "examples": [ + { + "options": "\"iefbr14.txt\"", + "description": "Submit the JCL in the file \"iefbr14.txt\"" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "stdin", + "aliases": [ + "in" + ], + "type": "command", + "summary": "Submit a job read from standard in", + "description": "Submit a job (JCL) passed to the command via the stdin stream. The command presents errors verbatim from the Jobs REST endpoints. For more information about Jobs API errors, see the Jobs API REST documentation.", + "handler": "", + "options": [ + { + "name": "view-all-spool-content", + "aliases": [ + "vasc" + ], + "description": "Print all spool output. If you use this option you will wait the job to complete.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-output", + "aliases": [ + "wfo" + ], + "description": "Wait for the job to enter OUTPUT status before completing the command.", + "type": "boolean", + "group": "Options" + }, + { + "name": "wait-for-active", + "aliases": [ + "wfa" + ], + "description": "Wait for the job to enter ACTIVE status before completing the command.", + "type": "boolean", + "conflictsWith": [ + "wait-for-output", + "view-all-spool-content", + "directory" + ], + "group": "Options" + }, + { + "name": "directory", + "aliases": [ + "d" + ], + "description": "The local directory you would like to download the output of the job. Creates a subdirectory using the jobID as the name and files are titled based on DD names. If you use this option you will wait the job to complete.", + "type": "string", + "group": "Options" + }, + { + "name": "extension", + "aliases": [ + "e" + ], + "description": "A file extension to save the job output with. Default is '.txt'.", + "type": "string", + "group": "Options" + }, + { + "name": "jcl-symbols", + "aliases": [ + "js" + ], + "description": "A string of JCL symbols to use for substitution. For symbol values with no spaces: \"symbol1=value1 symbol2=value2 ...\". When a value contains spaces, enclose the value in single quotes: \"symbol1='value 1 with spaces' symbol2='value 2 with spaces'...\". To embed a single quote in a value, use two single quotes: \"NAME=O''Brian\".", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "outputFormatOptions": true, + "examples": [ + { + "options": "--wait-for-output", + "prefix": "cat \"iefbr14.txt\" |", + "description": "Submit the JCL using stdin from the command: cat \"iefbr14.txt\", and then wait for the job to enter OUTPUT status before completing the command" + }, + { + "options": "--vasc", + "prefix": "cat \"iefbr14.txt\" |", + "description": "Submit the JCL using stdin from the command: cat \"iefbr14.txt\", and then printing all spool output" + } + ], + "positionals": [], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "upload", + "aliases": [ + "ul" + ], + "type": "group", + "description": "Upload the contents of a file to z/OS data sets or to z/OS UNIX System Services", + "children": [ + { + "name": "file-to-uss", + "aliases": [ + "ftu" + ], + "description": "Upload content to a z/OS UNIX System Services file from local file", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "inputfile", + "description": "The local file that you want to upload to a z/OS UNIX System Services file", + "type": "string", + "required": true + }, + { + "name": "USSFileName", + "description": "The name of the z/OS UNIX System Services file to which you want to upload the file", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Upload to the z/OS UNIX System Services file \"/a/ibmuser/my_text.txt\" from the file \"file.txt\"", + "options": "\"file.txt\" \"/a/ibmuser/my_text.txt\"" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "dir-to-uss", + "aliases": [ + "dtu" + ], + "summary": "Upload a local directory to a z/OS UNIX System Services directory", + "description": "Upload a local directory to a z/OS UNIX System Services directory.\n\nAn optional .zosattributes file in the source directory can be used to control file conversion and tagging.\n\nAn example .zosattributes file:{{space}}{{space}}\n# pattern local-encoding remote-encoding{{space}}{{space}}\n# Don't upload the node_modules directory{{space}}{{space}\nnode_modules -{{space}}{{space}\n# Don't upload files that start with periods{{space}}{{space}}\n.* - {{space}}{{space}\n# Upload jpg images in binary{{space}}{{space}}\n*.jpg binary binary{{space}}{{space}}\n# Convert CICS Node.js profiles to EBCDIC{{space}}{{space}}\n*.profile ISO8859-1 EBCDIC{{space}}{{space}}\n\nLines starting with the ‘#’ character are comments. Each line can specify up to three positional attributes:\n{{bullet}} A pattern to match a set of files. Pattern-matching syntax follows the same rules as those that apply in .gitignore files (note that negated patterns that begin with ‘!’ are not supported). See https://git-scm.com/docs/gitignore#_pattern_format.\nlocal-encoding, {{bullet}} A local-encoding to identify a file’s encoding on the local workstation. If '-' is specified for files that match the pattern are not transferred.\n{{bullet}} A remote-encoding to specify the file’s desired character set on z/OS UNIX System Services. This attribute must either match the local encoding or be set to EBCDIC. If set to EBCDIC, files are transferred in text mode and converted, otherwise they are transferred in binary mode. Remote files are tagged either with the remote encoding or as binary. \n \nDue to a limitation, files that are transferred in text mode are converted to the default EBCDIC code page on the z/OS system. Therefore the only EBCDIC code page to specify as the remote encoding is the default code page for your system.\n\n A .zosattributes file can either be placed in the top-level directory you want to upload, or its location can be specified by using the --attributes parameter. .zosattributes files that are placed in nested directories are ignored.\n", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "inputDir", + "description": "The local directory path that you want to upload to a z/OS UNIX System Services directory", + "type": "string", + "required": true + }, + { + "name": "USSDir", + "description": "The name of the z/OS UNIX System Services directory to which you want to upload the local directory", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "attributes", + "aliases": [ + "attrs" + ], + "description": "Path of an attributes file to control how files are uploaded", + "type": "string", + "conflictsWith": [ + "ascii-files, binary-files" + ], + "group": "Options" + }, + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "max-concurrent-requests", + "aliases": [ + "mcr" + ], + "description": "Specifies the maximum number of concurrent REST API requests to upload files. Increasing the value results in faster uploads. However, increasing the value increases resource consumption on z/OS and can be prone to errors caused by making too many concurrent requests. If the upload process encounters an error, the following message displays:\nThe maximum number of TSO address spaces have been created. When you specify 0, Zowe CLI attempts to upload all members at once without a maximum number of concurrent requests. ", + "type": "number", + "defaultValue": 1, + "numericValueRange": [ + 0, + 99999 + ], + "group": "Options" + }, + { + "name": "recursive", + "aliases": [ + "r" + ], + "description": "Upload all directories recursively.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Upload all files from the \"local_dir\" directory to the \"/a/ibmuser/my_dir\" z/OS UNIX System Services directory:\"", + "options": "\"local_dir\" \"/a/ibmuser/my_dir\"" + }, + { + "description": "Upload all files from the \"local_dir\" directory and all its sub-directories, to the \"/a/ibmuser/my_dir\" z/OS UNIX System Services directory:", + "options": "\"local_dir\" \"/a/ibmuser/my_dir\" --recursive" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "file-to-data-set", + "aliases": [ + "ftds" + ], + "description": "Upload the contents of a file to a z/OS data set", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "inputfile", + "description": "The local file that you want to upload to a data set", + "type": "string", + "required": true + }, + { + "name": "dataSetName", + "description": "The name of the data set to which you want to upload the file", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "mappings-file", + "aliases": [ + "maps" + ], + "description": "Location of an alternate MVS Mappings file.", + "type": "string", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Upload file contents to a sequential data set named \"ibmuser.ps\"", + "options": "\"file.txt\" \"ibmuser.ps\"" + }, + { + "description": "Upload file contents to a PDS member named \"ibmuser.pds(mem)\"", + "options": "\"file.txt\" \"ibmuser.pds(mem)\"" + } + ], + "passOn": [], + "children": [] + }, + { + "name": "dir-to-pds", + "aliases": [ + "dtp" + ], + "description": "Upload files from a local directory to a partitioned data set (PDS)", + "type": "command", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "inputdir", + "description": "The path for a local directory that you want to upload to a PDS", + "type": "string", + "required": true + }, + { + "name": "dataSetName", + "description": "The name of the partitioned data set to which you want to upload the files", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "binary", + "aliases": [ + "b" + ], + "description": "Data content in binary mode, which means that no data conversion is performed. The data transfer process returns each record as-is, without translation. No delimiters are added between records.", + "type": "boolean", + "group": "Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "Upload the file content with encoding mode, which means that data conversion is performed using the file encoding specified.", + "type": "string", + "group": "Options" + }, + { + "name": "mappings-file", + "aliases": [ + "maps" + ], + "description": "Location of an alternate MVS Mappings file.", + "type": "string", + "group": "Options" + }, + { + "name": "migrated-recall", + "aliases": [ + "mr" + ], + "description": "The method by which migrated data set is handled. By default, a migrated data set is recalled synchronously. You can specify the following values: wait, nowait, error", + "type": "string", + "defaultValue": "nowait", + "group": "Options" + }, + { + "name": "volume-serial", + "aliases": [ + "vs" + ], + "description": "The volume serial (VOLSER) where the data set resides. You can use this option at any time. However, the VOLSER is required only when the data set is not cataloged on the system. A VOLSER is analogous to a drive name on a PC.", + "type": "string", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "examples": [ + { + "description": "Upload a directory named \"src\" to a PDS named \"ibmuser.src\"", + "options": "\"src\" \"ibmuser.src\"" + }, + { + "description": "Upload a directory named \"src\" to a migrated PDS named \"ibmuser.src\" and wait for it to be recalled", + "options": "\"src\" \"ibmuser.src\" --mr wait" + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + }, + { + "name": "view", + "aliases": [ + "vw" + ], + "type": "group", + "summary": "View details of a z/OS job", + "description": "View details of z/OS jobs on spool/JES queues.", + "children": [ + { + "name": "job-status-by-jobid", + "aliases": [ + "jsbj" + ], + "type": "command", + "summary": "View status details of a z/OS job", + "description": "View status details of a single z/OS job on spool/JES queues. The command does not prevalidate the JOBID. The command presents errors verbatim from the Jobs REST endpoints (expect for \"no jobs found\").", + "handler": "", + "options": [ + { + "name": "attributes", + "aliases": [ + "a" + ], + "description": "Display more information about the job.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "response-format-filter", + "aliases": [ + "rff" + ], + "description": "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.", + "type": "array", + "group": "Response Format Options" + }, + { + "name": "response-format-type", + "aliases": [ + "rft" + ], + "description": "The command response output format type. Must be one of the following:\n\ntable: 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.\n\nlist: 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.\n\nobject: 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.\n\nstring: Formats output data as a string. JSON objects/arrays are stringified.", + "type": "string", + "allowableValues": { + "values": [ + "table", + "list", + "object", + "string" + ], + "caseSensitive": false + }, + "group": "Response Format Options" + }, + { + "name": "response-format-header", + "aliases": [ + "rfh" + ], + "description": "If \"--response-format-type table\" is specified, include the column headers in the output.", + "type": "boolean", + "group": "Response Format Options", + "defaultValue": null + } + ], + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The z/OS JOBID of the job you want to view. No prevalidation of the JOBID is performed.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "j123", + "description": "View status and other details of the job with the job ID JOB00123" + }, + { + "options": "j123 --rff status --rft string", + "description": "Print only the status (for example, \"OUTPUT\" or \"ACTIVE\") of the job with the job ID JOB00123" + } + ], + "outputFormatOptions": true, + "passOn": [], + "children": [] + }, + { + "name": "spool-file-by-id", + "aliases": [ + "sfbi" + ], + "type": "command", + "summary": "View a spool file from a z/OS job", + "description": "View the contents of a spool file from a z/OS job on spool/JES queues. The command does not pre-validate the JOBID or spool ID. The command presents errors verbatim from the Jobs REST endpoints.", + "handler": "", + "profile": { + "optional": [ + "rse", + "base" + ] + }, + "positionals": [ + { + "name": "jobid", + "description": "The z/OS JOBID of the job containing the spool file you want to view. No pre-validation of the JOBID is performed.", + "type": "string", + "required": true + }, + { + "name": "spoolfileid", + "description": "The spool file ID number for the spool file to view. Use the \"zowe rse list spool-files-by-jobid\" command to obtain spool ID numbers.No pre-validation of the ID is performed.", + "type": "number", + "required": true + } + ], + "examples": [ + { + "description": "View the spool file with ID 4 for the job with job ID JOB00123", + "options": "JOB00123 4" + } + ], + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + }, + { + "name": "job-step-info", + "aliases": [ + "jsi" + ], + "type": "command", + "summary": "View Step Info of z/OS Jobs", + "description": "View Step Info of specified job provided JOBNAME and JOBID", + "handler": "", + "positionals": [ + { + "name": "jobname", + "description": "The z/OS Job Name of the job containing the step information you want to view.", + "type": "string", + "required": true + }, + { + "name": "jobid", + "description": "The z/OS JobId of the job containing the step information you want to view.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "description": "Get Step Info of job JOBNAME IBMUSER JOBID JOB00134", + "options": "JOBNAME JOBID" + } + ], + "profile": { + "required": [ + "rse" + ], + "optional": [ + "base" + ] + }, + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + }, + { + "name": "rse-profile", + "aliases": [ + "rse-p" + ], + "group": "Profile Options", + "description": "The name of a (rse) profile to load for this command execution.", + "type": "string" + }, + { + "name": "base-profile", + "aliases": [ + "base-p" + ], + "group": "Profile Options", + "description": "The name of a (base) profile to load for this command execution.", + "type": "string" + }, + { + "name": "host", + "aliases": [ + "H" + ], + "description": "Host name of service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "Port number of service on the mainframe.", + "type": "number", + "group": "Base Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "User name to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass", + "pw" + ], + "description": "Password to authenticate to service on the mainframe.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Base Connection Options" + }, + { + "name": "token-type", + "aliases": [ + "tt" + ], + "description": "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'.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "token-value", + "aliases": [ + "tv" + ], + "description": "The value of the token to pass to the API.", + "type": "string", + "group": "Base Connection Options" + }, + { + "name": "cert-file", + "description": "The file path to a certificate file to use for authentication.\n\nNote: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + }, + { + "name": "cert-key-file", + "description": "The file path to a certificate key file to use for authentication", + "type": "existingLocalFile", + "group": "Base Connection Options", + "aliases": [] + } + ], + "passOn": [], + "children": [] + } + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] + } + ], + "summary": "IBM RSE API Plug-in for Zowe CLI", + "aliases": [ + "rse" + ], + "options": [ + { + "name": "help-examples", + "group": "Global Options", + "description": "Display examples for all the commands in a group", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [], + "passOn": [] +} \ No newline at end of file diff --git a/profiles/create/rse.jsonc b/profiles/create/rse.jsonc new file mode 100644 index 0000000..a35d80c --- /dev/null +++ b/profiles/create/rse.jsonc @@ -0,0 +1,192 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-profile", + "aliases": [ + "rse" + ], + "summary": "Create a rse profile", + "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config init' command", + "customize": { + "profileTypeIdentifier": "rse" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the \"--rse-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The z/OS host name running the Zowe REST API.", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The server port used by the REST API.", + "type": "number", + "defaultValue": 6800, + "group": "Zowe REST Connection Options" + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "The user name for the Zowe REST API operations.", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "The password of the user for the Zowe REST API operations.", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "defaultValue": true, + "group": "Zowe REST Connection Options" + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path of the API for the REST API operations.", + "type": "string", + "defaultValue": "rseapi", + "group": "Zowe REST Connection Options" + }, + { + "name": "protocol", + "aliases": [ + "protocol" + ], + "description": "http or https, depending whether a TLS handshake is required to access REST API.", + "type": "string", + "defaultValue": "https", + "group": "Zowe REST Connection Options" + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of \"IBM-1047\".", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "tokenType", + "aliases": [ + "tt" + ], + "description": "JWT token type assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "tokenValue", + "aliases": [ + "tv" + ], + "description": "JWT token value assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "string", + "group": "Zowe REST Connection Options" + }, + { + "name": "tokenExpiration", + "aliases": [ + "te" + ], + "description": "JWT token expiration assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "number", + "group": "Zowe REST Connection Options" + }, + { + "name": "overwrite", + "aliases": [ + "ow" + ], + "description": "Overwrite the rse profile when a profile of the same name exists.", + "type": "boolean", + "group": "Options" + }, + { + "name": "disable-defaults", + "aliases": [ + "dd" + ], + "description": "Disable populating profile values of undefined properties with default values.", + "type": "boolean", + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "myRseApiProfile --host zos123 --port 6800 --user ibmuser --pass myp4ss --bp rseapi --protocol http --ru false", + "description": "Create an RSE API profile named 'myRseApiProfile' to connect to z/OS using the RSE API server at host zos123 that runs on port 6800 and has a base path of 'rseapi' and uses the 'http' protocol. An example base URL to RSE API would be: 'http://zos123:6800/rseapi/api/v1/'" + }, + { + "options": "myZoweRestProfile --host zos123 --port 8443 --user ibmuser --pass myp4ss --ru false --protocol https --ec IBM-285", + "description": "Create a profile named 'myZoweRestProfile' to connect to z/OS using the Zowe REST APIs at host zos123 that runs the Zowe REST API server on port 8443, requires a TLS handshake using 'https' with SSL certificates, and has a default encoding of IBM-285. An example base URL to Zowe REST API would be: 'https://zos123:6800/api/v1/'" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/delete/rse.jsonc b/profiles/delete/rse.jsonc new file mode 100644 index 0000000..5248900 --- /dev/null +++ b/profiles/delete/rse.jsonc @@ -0,0 +1,75 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-profile", + "aliases": [ + "rse" + ], + "summary": "Delete a rse profile.", + "description": "Delete a rse profile. You must specify a profile name to be deleted. To find a list of available profiles for deletion, issue the profiles list command. By default, you will be prompted to confirm the profile removal.", + "type": "command", + "handler": "", + "deprecatedReplacement": "Edit your Zowe V2 configuration\n zowe.config.json", + "customize": { + "profileTypeIdentifier": "rse" + }, + "options": [ + { + "name": "force", + "aliases": [], + "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", + "type": "boolean", + "required": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the rse profile to be deleted. You can also load this profile by using the name on commands that support the \"--rse-profile\" option.", + "type": "string", + "required": true + } + ], + "examples": [ + { + "options": "profilename", + "description": "Delete a rse profile named profilename" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/list/rse.jsonc b/profiles/list/rse.jsonc new file mode 100644 index 0000000..68419ef --- /dev/null +++ b/profiles/list/rse.jsonc @@ -0,0 +1,74 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-profiles", + "aliases": [ + "rse" + ], + "summary": "List profiles of the type rse.", + "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config list' command", + "customize": { + "profileTypeIdentifier": "rse" + }, + "options": [ + { + "name": "show-contents", + "aliases": [ + "sc" + ], + "description": "List rse profiles and their contents. All profile details will be printed as part of command output.", + "type": "boolean", + "required": false, + "group": "Options" + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "examples": [ + { + "options": "", + "description": "List profiles of type rse" + }, + { + "options": "--sc", + "description": "List profiles of type rse and display their contents" + } + ], + "positionals": [], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/set-default/rse.jsonc b/profiles/set-default/rse.jsonc new file mode 100644 index 0000000..6a38290 --- /dev/null +++ b/profiles/set-default/rse.jsonc @@ -0,0 +1,67 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-profile", + "aliases": [ + "rse" + ], + "summary": "Set the default\n profiles for the rse group", + "description": "The rse set default-profiles command allows you to set the default profiles for this command group. When a rse command is issued and no profile override options are specified, the default profiles for the command group are automatically loaded for the command based on the commands profile requirements.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config set' command", + "options": [ + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "positionals": [ + { + "name": "profileName", + "description": "Specify a\n profile for default usage within the rse group. When you issue commands within the rse group without a profile specified as part of the command, the default will be loaded instead.", + "type": "string", + "required": true + } + ], + "customize": { + "profileTypeIdentifier": "rse" + }, + "examples": [ + { + "options": "profilename", + "description": "Set the default profile for type rse to the profile named 'profilename'" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file diff --git a/profiles/update/rse.jsonc b/profiles/update/rse.jsonc new file mode 100644 index 0000000..e1746a2 --- /dev/null +++ b/profiles/update/rse.jsonc @@ -0,0 +1,193 @@ +// Copyright IBM Corporation 2020, 2024. All Rights Reserved. +{ + "name": "rse-profile", + "aliases": [ + "rse" + ], + "summary": "Update a rse profile. You can update any property present within the profile configuration. The updated profile will be printed so that you can review the result of the updates.", + "description": "A profile to issue commands to a z/OS system with a working Zowe REST server,Mediation Layer, or IBM RSE (Remote System Explorer) API server installation.", + "type": "command", + "handler": "", + "deprecatedReplacement": "The 'config set' command", + "customize": { + "profileTypeIdentifier": "rse" + }, + "positionals": [ + { + "name": "profileName", + "description": "Specifies the name of the new rse profile. You can load this profile by using the name on commands that support the \"--rse-profile\" option.", + "type": "string", + "required": true + } + ], + "options": [ + { + "name": "host", + "aliases": [ + "H" + ], + "description": "The z/OS host name running the Zowe REST API.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "port", + "aliases": [ + "P" + ], + "description": "The server port used by the REST API.", + "type": "number", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "user", + "aliases": [ + "u" + ], + "description": "The user name for the Zowe REST API operations.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "password", + "aliases": [ + "pass" + ], + "description": "The password of the user for the Zowe REST API operations.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "reject-unauthorized", + "aliases": [ + "ru" + ], + "description": "Reject self-signed certificates.", + "type": "boolean", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "base-path", + "aliases": [ + "bp" + ], + "description": "The base path of the API for the REST API operations.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "protocol", + "aliases": [ + "protocol" + ], + "description": "http or https, depending whether a TLS handshake is required to access REST API.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "encoding", + "aliases": [ + "ec" + ], + "description": "The encoding for download and upload of z/OS data set and USS files. The encoding should be specified in the form of \"IBM-1047\".", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "tokenType", + "aliases": [ + "tt" + ], + "description": "JWT token type assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "tokenValue", + "aliases": [ + "tv" + ], + "description": "JWT token value assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "string", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "tokenExpiration", + "aliases": [ + "te" + ], + "description": "JWT token expiration assigned to profile when \"zowe rse auth login\" is used for authentication.", + "type": "number", + "group": "Zowe REST Connection Options", + "required": false, + "absenceImplications": null, + "implies": null + }, + { + "name": "show-inputs-only", + "group": "Global Options", + "description": "Show command inputs and do not run the command", + "type": "boolean", + "aliases": [] + }, + { + "name": "response-format-json", + "aliases": [ + "rfj" + ], + "group": "Global Options", + "description": "Produce JSON formatted data from a command", + "type": "boolean" + }, + { + "name": "help", + "aliases": [ + "h" + ], + "group": "Global Options", + "description": "Display help text", + "type": "boolean" + }, + { + "name": "help-web", + "aliases": [ + "hw" + ], + "group": "Global Options", + "description": "Display HTML help in browser", + "type": "boolean" + } + ], + "passOn": [], + "children": [] +} \ No newline at end of file