diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md index a57eeb9444..35f69e011c 100644 --- a/packages/cli/CHANGELOG.md +++ b/packages/cli/CHANGELOG.md @@ -2,6 +2,10 @@ All notable changes to the Zowe CLI package will be documented in this file. +## Recent Changes + +- Enhancement: Revised help text for consistency [#1756](https://github.com/zowe/zowe-cli/issues/1756) + ## `8.0.0-next.202401022112` - BugFix: Add missing npm-shrinkwrap diff --git a/packages/cli/__tests__/config/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap b/packages/cli/__tests__/config/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap index fba9202cc4..95d595d34d 100644 --- a/packages/cli/__tests__/config/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap +++ b/packages/cli/__tests__/config/auto-init/__integration__/__snapshots__/cli.config.auto-init.integration.test.ts.snap @@ -10,7 +10,7 @@ exports[`config auto-init help should display help 1`] = ` DESCRIPTION ----------- - Automatically generate a config from APIML + Automatically generate a config from APIML. USAGE ----- @@ -135,8 +135,8 @@ exports[`config auto-init help should display help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: auto-init.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Automatically generate a config from APIML\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n --user-config | --uc (boolean)\\\\n\\\\n Save config in the user layer\\\\n\\\\n Default value: false\\\\n\\\\n --global-config | --gc (boolean)\\\\n\\\\n Save config in the global layer\\\\n\\\\n Default value: false\\\\n\\\\n --dry-run | --dr | --dry (boolean)\\\\n\\\\n Display the outcome of the initialization without saving\\\\n\\\\n --edit | -e (boolean)\\\\n\\\\n Open in editor after initializing the configuration\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Replaces an existing configuration with a new configuration\\\\n\\\\n Default value: false\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Confirms the overwrite option\\\\n\\\\n Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --editor | --ed (string)\\\\n\\\\n Editor that overrides the default editor for this file type. Set the option to\\\\n the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n --port | -P (number)\\\\n\\\\n Port number of API Mediation Layer on the mainframe.\\\\n\\\\n --user | -u (string)\\\\n\\\\n User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API Mediation Layer. Omit this option\\\\n to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API Mediation Layer.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use to authenticate to the API Mediation\\\\n Layer\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use to authenticate to the API\\\\n Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Automatically generate a config from APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n --user-config | --uc (boolean)\\\\n\\\\n Save config in the user layer\\\\n\\\\n Default value: false\\\\n\\\\n --global-config | --gc (boolean)\\\\n\\\\n Save config in the global layer\\\\n\\\\n Default value: false\\\\n\\\\n --dry-run | --dr | --dry (boolean)\\\\n\\\\n Display the outcome of the initialization without saving\\\\n\\\\n --edit | -e (boolean)\\\\n\\\\n Open in editor after initializing the configuration\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Replaces an existing configuration with a new configuration\\\\n\\\\n Default value: false\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Confirms the overwrite option\\\\n\\\\n Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --editor | --ed (string)\\\\n\\\\n Editor that overrides the default editor for this file type. Set the option to\\\\n the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n --port | -P (number)\\\\n\\\\n Port number of API Mediation Layer on the mainframe.\\\\n\\\\n --user | -u (string)\\\\n\\\\n User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API Mediation Layer. Omit this option\\\\n to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API Mediation Layer.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use to authenticate to the API Mediation\\\\n Layer\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use to authenticate to the API\\\\n Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Automatically generate a config from APIML\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n --user-config | --uc (boolean)\\\\n\\\\n Save config in the user layer\\\\n\\\\n Default value: false\\\\n\\\\n --global-config | --gc (boolean)\\\\n\\\\n Save config in the global layer\\\\n\\\\n Default value: false\\\\n\\\\n --dry-run | --dr | --dry (boolean)\\\\n\\\\n Display the outcome of the initialization without saving\\\\n\\\\n --edit | -e (boolean)\\\\n\\\\n Open in editor after initializing the configuration\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Replaces an existing configuration with a new configuration\\\\n\\\\n Default value: false\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Confirms the overwrite option\\\\n\\\\n Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --editor | --ed (string)\\\\n\\\\n Editor that overrides the default editor for this file type. Set the option to\\\\n the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n --port | -P (number)\\\\n\\\\n Port number of API Mediation Layer on the mainframe.\\\\n\\\\n --user | -u (string)\\\\n\\\\n User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API Mediation Layer. Omit this option\\\\n to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API Mediation Layer.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use to authenticate to the API Mediation\\\\n Layer\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use to authenticate to the API\\\\n Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n auto-init\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Automatically generate a config from APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe config auto-init [options]\\\\n\\\\n AUTOMATIC CONFIG INITIALIZATION OPTIONS\\\\n ---------------------------------------\\\\n\\\\n --user-config | --uc (boolean)\\\\n\\\\n Save config in the user layer\\\\n\\\\n Default value: false\\\\n\\\\n --global-config | --gc (boolean)\\\\n\\\\n Save config in the global layer\\\\n\\\\n Default value: false\\\\n\\\\n --dry-run | --dr | --dry (boolean)\\\\n\\\\n Display the outcome of the initialization without saving\\\\n\\\\n --edit | -e (boolean)\\\\n\\\\n Open in editor after initializing the configuration\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Replaces an existing configuration with a new configuration\\\\n\\\\n Default value: false\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Confirms the overwrite option\\\\n\\\\n Default value: false\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --editor | --ed (string)\\\\n\\\\n Editor that overrides the default editor for this file type. Set the option to\\\\n the editor's executable file location or the program's name: ie \\\\\\"--editor\\\\n notepad\\\\\\"\\\\n\\\\n APIML CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n Host name of the mainframe running the API Mediation Layer.\\\\n\\\\n --port | -P (number)\\\\n\\\\n Port number of API Mediation Layer on the mainframe.\\\\n\\\\n --user | -u (string)\\\\n\\\\n User name to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Password to authenticate to the API Mediation Layer on the mainframe.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API Mediation Layer. Omit this option\\\\n to use the default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API Mediation Layer.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use to authenticate to the API Mediation\\\\n Layer\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use to authenticate to the API\\\\n Mediation Layer\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap b/packages/cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap index 6e99427591..768163d607 100644 --- a/packages/cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/daemon/__unit__/disable/__snapshots__/Disable.definition.unit.test.ts.snap @@ -2,7 +2,7 @@ exports[`daemon disable definition should not have changed 1`] = ` Object { - "description": "Disables daemon-mode operation of the Zowe CLI.", + "description": "Disable daemon-mode operation of the Zowe CLI.", "examples": Array [ Object { "description": "Disable daemon-mode", @@ -10,6 +10,7 @@ Object { }, ], "name": "disable", + "summary": "Disable daemon-mode operation of the Zowe CLI", "type": "command", } `; diff --git a/packages/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap b/packages/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap index 5b49455654..695530d528 100644 --- a/packages/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/daemon/__unit__/enable/__snapshots__/Enable.definition.unit.test.ts.snap @@ -2,7 +2,7 @@ exports[`daemon enable definition should not have changed 1`] = ` Object { - "description": "Enables daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.", + "description": "Enable daemon-mode operation of the Zowe CLI. You only need to run the enable command once after each new installation of the Zowe CLI. Afterwards, any zowe command will automatically start a daemon as needed.", "examples": Array [ Object { "description": "Enable daemon-mode", @@ -10,6 +10,7 @@ Object { }, ], "name": "enable", + "summary": "Enable daemon-mode operation of the Zowe CLI", "type": "command", } `; diff --git a/packages/cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap b/packages/cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap index 475757f497..f0ccfa63bd 100644 --- a/packages/cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/daemon/__unit__/restart/__snapshots__/restart.definition.unit.test.ts.snap @@ -1,6 +1,5 @@ // Jest Snapshot v1, https://goo.gl/fbAQLP - exports[`daemon restart definition should not have changed 1`] = ` Object { "description": "Restart the Zowe CLI daemon.", @@ -11,6 +10,7 @@ Object { }, ], "name": "restart", + "summary": "Restart the Zowe CLI daemon", "type": "command", } `; diff --git a/packages/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap b/packages/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap index 23878c0237..5de4e4ed5c 100644 --- a/packages/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap +++ b/packages/cli/__tests__/help/__integration__/__snapshots__/ZoweHelpTests.integration.test.ts.snap @@ -28,8 +28,8 @@ exports[`Root level help tests top level help should contain support link 1`] = auth Connect to Zowe API ML authentication service config Manage JSON project and global configuration daemon Daemon operations - plugins Install and manage plug-ins. - profiles Create and manage configuration profiles. + plugins Install and manage plug-ins + profiles Create and manage configuration profiles (deprecated) provisioning | pv Perform z/OSMF provisioning tasks zos-console | console Issue z/OS console commands and collect diff --git a/packages/cli/__tests__/provisioning/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap b/packages/cli/__tests__/provisioning/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap index 0f51b99108..b29ffc38a1 100644 --- a/packages/cli/__tests__/provisioning/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__integration__/delete/__snapshots__/cli.provisioning.delete.integration.test.ts.snap @@ -17,7 +17,7 @@ exports[`provisioning delete should display the help 1`] = ` COMMANDS -------- - template | tem Provision a published software service template. + template | tem Provision a published software service template GLOBAL OPTIONS -------------- @@ -42,8 +42,8 @@ exports[`provisioning delete should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: delete.\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning delete \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n instance | i Deletes instance.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning delete \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n instance | i Deletes instance\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning delete \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n instance | i Deletes instance.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Deletes instance previously provisioned with z/OSMF cloud provisioning services.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning delete \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n instance | i Deletes instance\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/provisioning/__integration__/perform/__snapshots__/cli.provisioning.perform.integration.test.ts.snap b/packages/cli/__tests__/provisioning/__integration__/perform/__snapshots__/cli.provisioning.perform.integration.test.ts.snap index c8436252bc..58a0363abe 100644 --- a/packages/cli/__tests__/provisioning/__integration__/perform/__snapshots__/cli.provisioning.perform.integration.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__integration__/perform/__snapshots__/cli.provisioning.perform.integration.test.ts.snap @@ -17,7 +17,7 @@ exports[`provisioning perform should display the help 1`] = ` COMMANDS -------- - action | act Perform instance actions. + action | act Perform instance actions GLOBAL OPTIONS -------------- @@ -42,8 +42,8 @@ exports[`provisioning perform should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: perform.\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Perform actions against instances provisioned with z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning perform \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n action | act Perform instance actions.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Perform actions against instances provisioned with z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning perform \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n action | act Perform instance actions\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Perform actions against instances provisioned with z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning perform \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n action | act Perform instance actions.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Perform actions against instances provisioned with z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning perform \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n action | act Perform instance actions\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/provisioning/__integration__/provision/__snapshots__/cli.provisioning.provision.integration.test.ts.snap b/packages/cli/__tests__/provisioning/__integration__/provision/__snapshots__/cli.provisioning.provision.integration.test.ts.snap index 0fb1c7d4c2..4038138db3 100644 --- a/packages/cli/__tests__/provisioning/__integration__/provision/__snapshots__/cli.provisioning.provision.integration.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__integration__/provision/__snapshots__/cli.provisioning.provision.integration.test.ts.snap @@ -17,7 +17,7 @@ exports[`provisioning provision should display the help 1`] = ` COMMANDS -------- - template | tem Provision a published software service template. + template | tem Provision a published software service template GLOBAL OPTIONS -------------- @@ -42,8 +42,8 @@ exports[`provisioning provision should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: provision.\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Using z/OSMF cloud provisioning services provision available templates.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning provision \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n template | tem Provision a published software service template.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Using z/OSMF cloud provisioning services provision available templates.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning provision \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n template | tem Provision a published software service template\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Using z/OSMF cloud provisioning services provision available templates.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning provision \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n template | tem Provision a published software service template.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Using z/OSMF cloud provisioning services provision available templates.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe provisioning provision \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n template | tem Provision a published software service template\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/provisioning/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap index 1161837de2..2482746d1a 100644 --- a/packages/cli/__tests__/provisioning/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap @@ -7,7 +7,7 @@ Object { ], "description": "Deletes instance previously provisioned with z/OSMF cloud provisioning services.", "name": "delete", - "summary": "Delete instance.", + "summary": "Delete instance", "type": "group", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/delete/instance/__snapshots__/DeleteInstance.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/delete/instance/__snapshots__/DeleteInstance.definition.unit.test.ts.snap index 8601c97a9c..15bd77fb34 100644 --- a/packages/cli/__tests__/provisioning/__unit__/delete/instance/__snapshots__/DeleteInstance.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/delete/instance/__snapshots__/DeleteInstance.definition.unit.test.ts.snap @@ -26,7 +26,7 @@ Object { "zosmf", ], }, - "summary": "Deletes instance.", + "summary": "Deletes instance", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/list/catalogTemplates/__snapshots__/CatalogTemplates.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/list/catalogTemplates/__snapshots__/CatalogTemplates.definition.unit.test.ts.snap index af82548f2e..d3c7099f28 100644 --- a/packages/cli/__tests__/provisioning/__unit__/list/catalogTemplates/__snapshots__/CatalogTemplates.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/list/catalogTemplates/__snapshots__/CatalogTemplates.definition.unit.test.ts.snap @@ -28,7 +28,7 @@ Object { "zosmf", ], }, - "summary": "List z/OSMF published catalog templates.", + "summary": "List z/OSMF published catalog templates", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/list/instanceInfo/__snapshots__/InstanceInfo.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/list/instanceInfo/__snapshots__/InstanceInfo.definition.unit.test.ts.snap index 3d0e2d8765..c9870593b7 100644 --- a/packages/cli/__tests__/provisioning/__unit__/list/instanceInfo/__snapshots__/InstanceInfo.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/list/instanceInfo/__snapshots__/InstanceInfo.definition.unit.test.ts.snap @@ -54,7 +54,7 @@ full - all available information "zosmf", ], }, - "summary": "List Provisioned Instance Details.", + "summary": "List Provisioned Instance Details", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/list/instanceVars/__snapshots__/InstanceVariables.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/list/instanceVars/__snapshots__/InstanceVariables.definition.unit.test.ts.snap index a154ad89ae..01151d2ea2 100644 --- a/packages/cli/__tests__/provisioning/__unit__/list/instanceVars/__snapshots__/InstanceVariables.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/list/instanceVars/__snapshots__/InstanceVariables.definition.unit.test.ts.snap @@ -27,7 +27,7 @@ Object { "zosmf", ], }, - "summary": "List Instance Variables and Values.", + "summary": "List Instance Variables and Values", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/list/registryInstances/__snapshots__/RegistryInstances.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/list/registryInstances/__snapshots__/RegistryInstances.definition.unit.test.ts.snap index ef614db4a3..91e4719015 100644 --- a/packages/cli/__tests__/provisioning/__unit__/list/registryInstances/__snapshots__/RegistryInstances.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/list/registryInstances/__snapshots__/RegistryInstances.definition.unit.test.ts.snap @@ -52,7 +52,7 @@ Object { "zosmf", ], }, - "summary": "List provisioned instances.", + "summary": "List provisioned instances", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/list/templateInfo/__snapshots__/TemplateInfo.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/list/templateInfo/__snapshots__/TemplateInfo.definition.unit.test.ts.snap index 32e7224735..df7bc175c2 100644 --- a/packages/cli/__tests__/provisioning/__unit__/list/templateInfo/__snapshots__/TemplateInfo.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/list/templateInfo/__snapshots__/TemplateInfo.definition.unit.test.ts.snap @@ -36,7 +36,7 @@ Object { "zosmf", ], }, - "summary": "List Published Template Details.", + "summary": "List Published Template Details", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/perform/__snapshots__/Perform.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/perform/__snapshots__/Perform.definition.unit.test.ts.snap index fc124cb936..b21a83e45d 100644 --- a/packages/cli/__tests__/provisioning/__unit__/perform/__snapshots__/Perform.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/perform/__snapshots__/Perform.definition.unit.test.ts.snap @@ -7,7 +7,7 @@ Object { ], "description": "Perform actions against instances provisioned with z/OSMF.", "name": "perform", - "summary": "Perform instance actions.", + "summary": "Perform instance actions", "type": "group", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/perform/action/__snapshots__/Action.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/perform/action/__snapshots__/Action.definition.unit.test.ts.snap index 18acff747e..d4553339ba 100644 --- a/packages/cli/__tests__/provisioning/__unit__/perform/action/__snapshots__/Action.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/perform/action/__snapshots__/Action.definition.unit.test.ts.snap @@ -37,7 +37,7 @@ Object { "zosmf", ], }, - "summary": "Perform instance actions.", + "summary": "Perform instance actions", "type": "command", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/provision/__snapshots__/Provision.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/provision/__snapshots__/Provision.definition.unit.test.ts.snap index 41a90b2d2d..90314bafb2 100644 --- a/packages/cli/__tests__/provisioning/__unit__/provision/__snapshots__/Provision.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/provision/__snapshots__/Provision.definition.unit.test.ts.snap @@ -7,7 +7,7 @@ Object { ], "description": "Using z/OSMF cloud provisioning services provision available templates.", "name": "provision", - "summary": "Provision published software service templates.", + "summary": "Provision published software service templates", "type": "group", } `; diff --git a/packages/cli/__tests__/provisioning/__unit__/provision/template/__snapshots__/Template.definition.unit.test.ts.snap b/packages/cli/__tests__/provisioning/__unit__/provision/template/__snapshots__/Template.definition.unit.test.ts.snap index f7c1c0bcab..3199de7d84 100644 --- a/packages/cli/__tests__/provisioning/__unit__/provision/template/__snapshots__/Template.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/provisioning/__unit__/provision/template/__snapshots__/Template.definition.unit.test.ts.snap @@ -95,7 +95,7 @@ e.g: \\"SYSNAME1,SYSNAME2\\".", "zosmf", ], }, - "summary": "Provision a published software service template.", + "summary": "Provision a published software service template", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__integration__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap index acfdd3f3f0..c4b36f8afe 100644 --- a/packages/cli/__tests__/workflows/__integration__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/create/dataset/__snapshots__/cli.workflows.create.workflowDs.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create workflow with data set integration test should display create wo DESCRIPTION ----------- - Create a z/OSMF workflow on a z/OS system using a Data set + Create a z/OSMF workflow on a z/OS system using a data set. USAGE ----- @@ -30,7 +30,7 @@ exports[`Create workflow with data set integration test should display create wo --data-set | --ds (string) - Data set that contains a workflow definiton. + Data set that contains a workflow definition. --system-name | --sn (string) @@ -235,8 +235,8 @@ exports[`Create workflow with data set integration test should display create wo \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: workflow-from-data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-data-set | wfds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a Data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --data-set | --ds (string)\\\\n\\\\n Data set that contains a workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete succesfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains a workflow definition xml, on a system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"MYSYSID\\\\\\" and with the variable name DUMMYVAR and the value\\\\n DUMMYVAL. Assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables DUMMYVAR=DUMMYVAL --assign-to-owner\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-data-set | wfds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --data-set | --ds (string)\\\\n\\\\n Data set that contains a workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete succesfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains a workflow definition xml, on a system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"MYSYSID\\\\\\" and with the variable name DUMMYVAR and the value\\\\n DUMMYVAL. Assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables DUMMYVAR=DUMMYVAL --assign-to-owner\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-data-set | wfds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a Data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --data-set | --ds (string)\\\\n\\\\n Data set that contains a workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete succesfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains a workflow definition xml, on a system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"MYSYSID\\\\\\" and with the variable name DUMMYVAR and the value\\\\n DUMMYVAL. Assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables DUMMYVAR=DUMMYVAL --assign-to-owner\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-data-set | wfds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --data-set | --ds (string)\\\\n\\\\n Data set that contains a workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete succesfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using data set\\\\n \\\\\\"TESTID.WKFLOW\\\\\\" containing workflow definition xml, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the data\\\\n set \\\\\\"TESTID.WKFLOW\\\\\\" that contains a workflow definition xml, on a system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"MYSYSID\\\\\\" and with the variable name DUMMYVAR and the value\\\\n DUMMYVAL. Assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-data-set \\\\\\"testworkflow\\\\\\" --data-set \\\\\\"TESTID.WKFLOW\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables DUMMYVAR=DUMMYVAL --assign-to-owner\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/create/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/create/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap index 46f8ea1177..3a75853ff8 100644 --- a/packages/cli/__tests__/workflows/__integration__/create/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/create/localfile/__snapshots__/cli.workflows.create.workflowLocalFile.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create workflow with local file integration test should display create DESCRIPTION ----------- - Create a z/OSMF workflow on a z/OS system using a Local file + Create a z/OSMF workflow on a z/OS system using a local file. USAGE ----- @@ -30,7 +30,7 @@ exports[`Create workflow with local file integration test should display create --local-file | --lf (string) - Local file that contains workflow definiton. + Local file that contains workflow definition. --system-name | --sn (string) @@ -76,8 +76,8 @@ exports[`Create workflow with local file integration test should display create --remote-directory | --rd (string) - The remote uss directory where the files are to be uploaded. The directory has - to exist + The remote USS directory where the files are to be uploaded. The directory has + to exist. --keep-files | --kf (boolean) @@ -227,8 +227,8 @@ exports[`Create workflow with local file integration test should display create \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: workflow-from-local-file.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-local-file | wflf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a Local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-local-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --local-file | --lf (string)\\\\n\\\\n Local file that contains workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n --remote-directory | --rd (string)\\\\n\\\\n The remote uss directory where the files are to be uploaded. The directory has\\\\n to exist\\\\n\\\\n --keep-files | --kf (boolean)\\\\n\\\\n Avoid deletion the uploaded files in /tmp or another specified directory after\\\\n successful execution.\\\\n\\\\n Default value: false\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the local\\\\n file \\\\\\"TESTID_WKFLOW.xml\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-local-file \\\\\\"testworkflow\\\\\\" --local-file \\\\\\"TESTID_WKFLOW.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-local-file | wflf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-local-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --local-file | --lf (string)\\\\n\\\\n Local file that contains workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n --remote-directory | --rd (string)\\\\n\\\\n The remote USS directory where the files are to be uploaded. The directory has\\\\n to exist.\\\\n\\\\n --keep-files | --kf (boolean)\\\\n\\\\n Avoid deletion the uploaded files in /tmp or another specified directory after\\\\n successful execution.\\\\n\\\\n Default value: false\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the local\\\\n file \\\\\\"TESTID_WKFLOW.xml\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-local-file \\\\\\"testworkflow\\\\\\" --local-file \\\\\\"TESTID_WKFLOW.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-local-file | wflf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a Local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-local-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --local-file | --lf (string)\\\\n\\\\n Local file that contains workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n --remote-directory | --rd (string)\\\\n\\\\n The remote uss directory where the files are to be uploaded. The directory has\\\\n to exist\\\\n\\\\n --keep-files | --kf (boolean)\\\\n\\\\n Avoid deletion the uploaded files in /tmp or another specified directory after\\\\n successful execution.\\\\n\\\\n Default value: false\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the local\\\\n file \\\\\\"TESTID_WKFLOW.xml\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-local-file \\\\\\"testworkflow\\\\\\" --local-file \\\\\\"TESTID_WKFLOW.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-local-file | wflf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a z/OSMF workflow on a z/OS system using a local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-local-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --local-file | --lf (string)\\\\n\\\\n Local file that contains workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n --remote-directory | --rd (string)\\\\n\\\\n The remote USS directory where the files are to be uploaded. The directory has\\\\n to exist.\\\\n\\\\n --keep-files | --kf (boolean)\\\\n\\\\n Avoid deletion the uploaded files in /tmp or another specified directory after\\\\n successful execution.\\\\n\\\\n Default value: false\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using the local\\\\n file \\\\\\"TESTID_WKFLOW.xml\\\\\\" that contains the workflow definition xml on the system\\\\n \\\\\\"TESTM1\\\\\\" with owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it\\\\n already exist in z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-local-file \\\\\\"testworkflow\\\\\\" --local-file \\\\\\"TESTID_WKFLOW.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap index 02f263b897..f622bee22c 100644 --- a/packages/cli/__tests__/workflows/__integration__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/create/ussfile/__snapshots__/cli.workflows.create.workflowUss.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create workflow with uss file integration test should display create wo DESCRIPTION ----------- - Create a workflow instance in z/OSMF using a USS file + Create a workflow instance in z/OSMF using a USS file. USAGE ----- @@ -30,7 +30,7 @@ exports[`Create workflow with uss file integration test should display create wo --uss-file | --uf (string) - Uss file that contains workflow definiton. + USS file that contains workflow definition. --system-name | --sn (string) @@ -235,8 +235,8 @@ exports[`Create workflow with uss file integration test should display create wo \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: workflow-from-uss-file.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-uss-file | wfuf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a workflow instance in z/OSMF using a USS file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow instance to create\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --uss-file | --uf (string)\\\\n\\\\n Uss file that contains workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it already exist in\\\\n z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete successfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variables VAR1 and VAR2 with values DUMMYVAL1 and\\\\n DUMMYVAL2, and assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner \\\\\\"MYSYSID\\\\\\" --assign-to-owner\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-uss-file | wfuf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a workflow instance in z/OSMF using a USS file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow instance to create\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --uss-file | --uf (string)\\\\n\\\\n USS file that contains workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it already exist in\\\\n z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete successfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variables VAR1 and VAR2 with values DUMMYVAL1 and\\\\n DUMMYVAL2, and assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner \\\\\\"MYSYSID\\\\\\" --assign-to-owner\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-uss-file | wfuf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a workflow instance in z/OSMF using a USS file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow instance to create\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --uss-file | --uf (string)\\\\n\\\\n Uss file that contains workflow definiton.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it already exist in\\\\n z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete successfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variables VAR1 and VAR2 with values DUMMYVAL1 and\\\\n DUMMYVAL2, and assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner \\\\\\"MYSYSID\\\\\\" --assign-to-owner\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n workflow-from-uss-file | wfuf\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a workflow instance in z/OSMF using a USS file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows create workflow-from-uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n workflowName\\\\t\\\\t (string)\\\\n\\\\n Name of the workflow instance to create\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --uss-file | --uf (string)\\\\n\\\\n USS file that contains workflow definition.\\\\n\\\\n --system-name | --sn (string)\\\\n\\\\n z/OS system to execute the workflow.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n User ID of the workflow owner. This user can perform the workflow steps or\\\\n delegate the steps to other users.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --variables-input-file | --vif (string)\\\\n\\\\n Specifies an optional properties file that you can use to pre-specify values for\\\\n one or more of the variables that are defined in the workflow definition file.\\\\n\\\\n --variables | --vs (string)\\\\n\\\\n Includes a list of variables for the workflow. The variables that you specify\\\\n here take precedence over the variables that are specified in the workflow\\\\n variable input file. Make sure the value meets all regular expression\\\\n requirements set for the corresponding variable.\\\\n\\\\n --assign-to-owner | --ato (boolean)\\\\n\\\\n Indicates whether the workflow steps are assigned to the workflow owner.\\\\n\\\\n --access-type | --at (string)\\\\n\\\\n Specifies the access type for the workflow. Public, Restricted or Private.\\\\n\\\\n Allowed values: Public, Restricted, Private\\\\n\\\\n --delete-completed | --dc (boolean)\\\\n\\\\n Whether the successfully completed jobs to be deleted from the JES spool.\\\\n\\\\n --overwrite | --ov (boolean)\\\\n\\\\n Replaces an existing workflow with a new workflow.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"OTHERID\\\\\\" and delete workflow with the same name if it already exist in\\\\n z/OSMF:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"OTHERID\\\\\\" --overwrite\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and delete successfully completed jobs:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --delete-completed\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variable values in the member PROPERTIES of data set\\\\n TESTID.DATA:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\" --owner \\\\\\"MYSYSID\\\\\\" --variables-input-file TESTID.DATA(PROPERTIES)\\\\n\\\\n - Create a workflow with name \\\\\\"testworkflow\\\\\\" using uss file\\\\n \\\\\\"/path/workflow.xml\\\\\\" containing workflow definition, on system \\\\\\"TESTM1\\\\\\" with\\\\n owner \\\\\\"MYSYSID\\\\\\" and with variables VAR1 and VAR2 with values DUMMYVAL1 and\\\\n DUMMYVAL2, and assign it to the owner:\\\\n\\\\n $ zowe zos-workflows create workflow-from-uss-file \\\\\\"testworkflow\\\\\\" --uss-file \\\\\\"/path/workflow.xml\\\\\\" --system-name \\\\\\"TESTM1\\\\\\"--variables VAR1=DUMMYVAL1,VAR2=DUMMYVAL2 --owner \\\\\\"MYSYSID\\\\\\" --assign-to-owner\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/delete/activeWorkflow/__snapshots__/cli.workflows.delete.activeworkflow.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/delete/activeWorkflow/__snapshots__/cli.workflows.delete.activeworkflow.integration.test.ts.snap index 45394408f3..51b85d298c 100644 --- a/packages/cli/__tests__/workflows/__integration__/delete/activeWorkflow/__snapshots__/cli.workflows.delete.activeworkflow.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/delete/activeWorkflow/__snapshots__/cli.workflows.delete.activeworkflow.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Delete active workflow integration test should display delete workflow DESCRIPTION ----------- - Delete an active workflow instance in z/OSMF + Delete an active workflow instance in z/OSMF. USAGE ----- @@ -142,8 +142,8 @@ exports[`Delete active workflow integration test should display delete workflow \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: active-workflow.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an active workflow instance in z/OSMF\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete active-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete active workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete active workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow key\\\\n \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow name\\\\n \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple workflow instances in z/OSMF with names\\\\n starting with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an active workflow instance in z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete active-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete active workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete active workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow key\\\\n \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow name\\\\n \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple workflow instances in z/OSMF with names\\\\n starting with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an active workflow instance in z/OSMF\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete active-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete active workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete active workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow key\\\\n \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow name\\\\n \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple workflow instances in z/OSMF with names\\\\n starting with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an active workflow instance in z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete active-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete active workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete active workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow key\\\\n \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete a workflow instance in z/OSMF with workflow name\\\\n \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple workflow instances in z/OSMF with names\\\\n starting with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete active-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/delete/archivedWorkflow/__snapshots__/cli.workflows.delete.archivedworkflow.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/delete/archivedWorkflow/__snapshots__/cli.workflows.delete.archivedworkflow.integration.test.ts.snap index a0929a54b2..8694b16276 100644 --- a/packages/cli/__tests__/workflows/__integration__/delete/archivedWorkflow/__snapshots__/cli.workflows.delete.archivedworkflow.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/delete/archivedWorkflow/__snapshots__/cli.workflows.delete.archivedworkflow.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Delete archived workflow integration test should display delete workflo DESCRIPTION ----------- - Delete an archived workflow from z/OSMF + Delete an archived workflow from z/OSMF. USAGE ----- @@ -142,8 +142,8 @@ exports[`Delete archived workflow integration test should display delete workflo \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: archived-workflow.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n archived-workflow | arw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an archived workflow from z/OSMF\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete archived-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete an archived workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete an archived workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n name \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple archived workflows from z/OSMF with\\\\n names beginnig with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n archived-workflow | arw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an archived workflow from z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete archived-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete an archived workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete an archived workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n name \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple archived workflows from z/OSMF with\\\\n names beginnig with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n archived-workflow | arw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an archived workflow from z/OSMF\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete archived-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete an archived workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete an archived workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n name \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple archived workflows from z/OSMF with\\\\n names beginnig with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n archived-workflow | arw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete an archived workflow from z/OSMF.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows delete archived-workflow [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n Delete an archived workflow by specified workflow key\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Delete an archived workflow by specified workflow name\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-key \\\\\\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\\\\\"\\\\n\\\\n - To delete an archived workflow from z/OSMF with workflow\\\\n name \\\\\\"testWorkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"testWorkflow\\\\\\"\\\\n\\\\n - To delete multiple archived workflows from z/OSMF with\\\\n names beginnig with \\\\\\"test\\\\\\":\\\\n\\\\n $ zowe zos-workflows delete archived-workflow --workflow-name \\\\\\"test.*\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/list/activeWorkflowDetails/__snapshots__/cli.workflows.list.activeWorkflowDetails.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/list/activeWorkflowDetails/__snapshots__/cli.workflows.list.activeWorkflowDetails.integration.test.ts.snap index 0da8a17c9d..5aef25f392 100644 --- a/packages/cli/__tests__/workflows/__integration__/list/activeWorkflowDetails/__snapshots__/cli.workflows.list.activeWorkflowDetails.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/list/activeWorkflowDetails/__snapshots__/cli.workflows.list.activeWorkflowDetails.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`List Active Workflow Details should display the help 1`] = ` DESCRIPTION ----------- - Get the details of an active z/OSMF workflow + Get the details of an active z/OSMF workflow. USAGE ----- @@ -153,8 +153,8 @@ exports[`List Active Workflow Details should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: active-workflow-details.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow-details | awd\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Get the details of an active z/OSMF workflow\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflow-details [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n List active workflow details by specified workflow name.\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n List active workflow details by specified workflow key.\\\\n\\\\n --list-steps | --ls (boolean)\\\\n\\\\n Optional parameter for listing steps and their properties.\\\\n\\\\n --steps-summary-only | --sso (boolean)\\\\n\\\\n Optional parameter that lists steps summary only.\\\\n\\\\n --list-variables | --lv (boolean)\\\\n\\\\n Optional parameter for listing variables and their properties.\\\\n\\\\n --skip-workflow-summary | --sws (boolean)\\\\n\\\\n Optional parameter that skips the default workflow summary.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To list the details of an active workflow with key\\\\n \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-key \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" --list-steps --list-variables\\\\n\\\\n - To list the details of an active workflow with name\\\\n \\\\\\"testWorkflow\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-name \\\\\\"testWorkflow\\\\\\" --list-steps --list-variables\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow-details | awd\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Get the details of an active z/OSMF workflow.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflow-details [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n List active workflow details by specified workflow name.\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n List active workflow details by specified workflow key.\\\\n\\\\n --list-steps | --ls (boolean)\\\\n\\\\n Optional parameter for listing steps and their properties.\\\\n\\\\n --steps-summary-only | --sso (boolean)\\\\n\\\\n Optional parameter that lists steps summary only.\\\\n\\\\n --list-variables | --lv (boolean)\\\\n\\\\n Optional parameter for listing variables and their properties.\\\\n\\\\n --skip-workflow-summary | --sws (boolean)\\\\n\\\\n Optional parameter that skips the default workflow summary.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To list the details of an active workflow with key\\\\n \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-key \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" --list-steps --list-variables\\\\n\\\\n - To list the details of an active workflow with name\\\\n \\\\\\"testWorkflow\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-name \\\\\\"testWorkflow\\\\\\" --list-steps --list-variables\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow-details | awd\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Get the details of an active z/OSMF workflow\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflow-details [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n List active workflow details by specified workflow name.\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n List active workflow details by specified workflow key.\\\\n\\\\n --list-steps | --ls (boolean)\\\\n\\\\n Optional parameter for listing steps and their properties.\\\\n\\\\n --steps-summary-only | --sso (boolean)\\\\n\\\\n Optional parameter that lists steps summary only.\\\\n\\\\n --list-variables | --lv (boolean)\\\\n\\\\n Optional parameter for listing variables and their properties.\\\\n\\\\n --skip-workflow-summary | --sws (boolean)\\\\n\\\\n Optional parameter that skips the default workflow summary.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To list the details of an active workflow with key\\\\n \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-key \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" --list-steps --list-variables\\\\n\\\\n - To list the details of an active workflow with name\\\\n \\\\\\"testWorkflow\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-name \\\\\\"testWorkflow\\\\\\" --list-steps --list-variables\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflow-details | awd\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Get the details of an active z/OSMF workflow.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflow-details [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n List active workflow details by specified workflow name.\\\\n\\\\n --workflow-key | --wk (string)\\\\n\\\\n List active workflow details by specified workflow key.\\\\n\\\\n --list-steps | --ls (boolean)\\\\n\\\\n Optional parameter for listing steps and their properties.\\\\n\\\\n --steps-summary-only | --sso (boolean)\\\\n\\\\n Optional parameter that lists steps summary only.\\\\n\\\\n --list-variables | --lv (boolean)\\\\n\\\\n Optional parameter for listing variables and their properties.\\\\n\\\\n --skip-workflow-summary | --sws (boolean)\\\\n\\\\n Optional parameter that skips the default workflow summary.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - To list the details of an active workflow with key\\\\n \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-key \\\\\\"7c62c790-0340-86b2-61ce618d8f8c\\\\\\" --list-steps --list-variables\\\\n\\\\n - To list the details of an active workflow with name\\\\n \\\\\\"testWorkflow\\\\\\" including its steps and variables:\\\\n\\\\n $ zowe zos-workflows list active-workflow-details --workflow-name \\\\\\"testWorkflow\\\\\\" --list-steps --list-variables\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__integration__/list/activeWorkflows/__snapshots__/cli.workflows.list.activeWorkflows.integration.test.ts.snap b/packages/cli/__tests__/workflows/__integration__/list/activeWorkflows/__snapshots__/cli.workflows.list.activeWorkflows.integration.test.ts.snap index 91644fdd6d..7b18277e80 100644 --- a/packages/cli/__tests__/workflows/__integration__/list/activeWorkflows/__snapshots__/cli.workflows.list.activeWorkflows.integration.test.ts.snap +++ b/packages/cli/__tests__/workflows/__integration__/list/activeWorkflows/__snapshots__/cli.workflows.list.activeWorkflows.integration.test.ts.snap @@ -13,7 +13,7 @@ exports[`List Active Workflows should display the help 1`] = ` List active workflow instance(s) in z/OSMF. Multiple filters can be used together. - Omitting all options will list all workflows on the sysplex + Omitting all options will list all workflows on the sysplex. USAGE ----- @@ -198,8 +198,8 @@ exports[`List Active Workflows should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: active-workflows.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflows | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List active workflow instance(s) in z/OSMF.\\\\n Multiple filters can be used together.\\\\n Omitting all options will list all workflows on the sysplex\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflows [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Filter by workflow name. For wildcard use .*\\\\n\\\\n --category | --cat (string)\\\\n\\\\n Filter by the category of the workflows, which is either general or\\\\n configuration.\\\\n\\\\n --system | --sys (string)\\\\n\\\\n Filter by the nickname of the system on which the workflows is/are active.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n Filter by owner of the workflow(s) (a valid z/OS user ID).\\\\n\\\\n --vendor | --vd (string)\\\\n\\\\n Filter by the name of the vendor that provided the workflow(s) definition file.\\\\n\\\\n --status-name | --sn (string)\\\\n\\\\n Filter by the status of the workflow(s).\\\\n\\\\n Allowed values: in-progress, complete, automation-in-progress, canceled\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List the workflow with name \\\\\\"testworkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"testworkflow\\\\\\"\\\\n\\\\n - List multiple active workflows on the entire syspex with\\\\n names containing\\\\\\"workflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\".*workflow.*\\\\\\"\\\\n\\\\n - List multiple active workflows on system \\\\\\"IBMSYS\\\\\\" with\\\\n names beginnig with \\\\\\"testW\\\\\\" that are in status \\\\\\"complete\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"test.*\\\\\\" --sys \\\\\\"IBMSYS\\\\\\" --sn \\\\\\"complete\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflows | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List active workflow instance(s) in z/OSMF.\\\\n Multiple filters can be used together.\\\\n Omitting all options will list all workflows on the sysplex.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflows [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Filter by workflow name. For wildcard use .*\\\\n\\\\n --category | --cat (string)\\\\n\\\\n Filter by the category of the workflows, which is either general or\\\\n configuration.\\\\n\\\\n --system | --sys (string)\\\\n\\\\n Filter by the nickname of the system on which the workflows is/are active.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n Filter by owner of the workflow(s) (a valid z/OS user ID).\\\\n\\\\n --vendor | --vd (string)\\\\n\\\\n Filter by the name of the vendor that provided the workflow(s) definition file.\\\\n\\\\n --status-name | --sn (string)\\\\n\\\\n Filter by the status of the workflow(s).\\\\n\\\\n Allowed values: in-progress, complete, automation-in-progress, canceled\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List the workflow with name \\\\\\"testworkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"testworkflow\\\\\\"\\\\n\\\\n - List multiple active workflows on the entire syspex with\\\\n names containing\\\\\\"workflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\".*workflow.*\\\\\\"\\\\n\\\\n - List multiple active workflows on system \\\\\\"IBMSYS\\\\\\" with\\\\n names beginnig with \\\\\\"testW\\\\\\" that are in status \\\\\\"complete\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"test.*\\\\\\" --sys \\\\\\"IBMSYS\\\\\\" --sn \\\\\\"complete\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflows | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List active workflow instance(s) in z/OSMF.\\\\n Multiple filters can be used together.\\\\n Omitting all options will list all workflows on the sysplex\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflows [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Filter by workflow name. For wildcard use .*\\\\n\\\\n --category | --cat (string)\\\\n\\\\n Filter by the category of the workflows, which is either general or\\\\n configuration.\\\\n\\\\n --system | --sys (string)\\\\n\\\\n Filter by the nickname of the system on which the workflows is/are active.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n Filter by owner of the workflow(s) (a valid z/OS user ID).\\\\n\\\\n --vendor | --vd (string)\\\\n\\\\n Filter by the name of the vendor that provided the workflow(s) definition file.\\\\n\\\\n --status-name | --sn (string)\\\\n\\\\n Filter by the status of the workflow(s).\\\\n\\\\n Allowed values: in-progress, complete, automation-in-progress, canceled\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List the workflow with name \\\\\\"testworkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"testworkflow\\\\\\"\\\\n\\\\n - List multiple active workflows on the entire syspex with\\\\n names containing\\\\\\"workflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\".*workflow.*\\\\\\"\\\\n\\\\n - List multiple active workflows on system \\\\\\"IBMSYS\\\\\\" with\\\\n names beginnig with \\\\\\"testW\\\\\\" that are in status \\\\\\"complete\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"test.*\\\\\\" --sys \\\\\\"IBMSYS\\\\\\" --sn \\\\\\"complete\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n active-workflows | aw\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List active workflow instance(s) in z/OSMF.\\\\n Multiple filters can be used together.\\\\n Omitting all options will list all workflows on the sysplex.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-workflows list active-workflows [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --workflow-name | --wn (string)\\\\n\\\\n Filter by workflow name. For wildcard use .*\\\\n\\\\n --category | --cat (string)\\\\n\\\\n Filter by the category of the workflows, which is either general or\\\\n configuration.\\\\n\\\\n --system | --sys (string)\\\\n\\\\n Filter by the nickname of the system on which the workflows is/are active.\\\\n\\\\n --owner | --ow (string)\\\\n\\\\n Filter by owner of the workflow(s) (a valid z/OS user ID).\\\\n\\\\n --vendor | --vd (string)\\\\n\\\\n Filter by the name of the vendor that provided the workflow(s) definition file.\\\\n\\\\n --status-name | --sn (string)\\\\n\\\\n Filter by the status of the workflow(s).\\\\n\\\\n Allowed values: in-progress, complete, automation-in-progress, canceled\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - List the workflow with name \\\\\\"testworkflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"testworkflow\\\\\\"\\\\n\\\\n - List multiple active workflows on the entire syspex with\\\\n names containing\\\\\\"workflow\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\".*workflow.*\\\\\\"\\\\n\\\\n - List multiple active workflows on system \\\\\\"IBMSYS\\\\\\" with\\\\n names beginnig with \\\\\\"testW\\\\\\" that are in status \\\\\\"complete\\\\\\":\\\\n\\\\n $ zowe zos-workflows list active-workflows --wn \\\\\\"test.*\\\\\\" --sys \\\\\\"IBMSYS\\\\\\" --sn \\\\\\"complete\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/workflows/__unit__/archive/__snapshots__/Archive.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/archive/__snapshots__/Archive.definition.unit.test.ts.snap index 1f90e15b2a..09ddae7b3c 100644 --- a/packages/cli/__tests__/workflows/__unit__/archive/__snapshots__/Archive.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/archive/__snapshots__/Archive.definition.unit.test.ts.snap @@ -4,6 +4,7 @@ exports[`zos-workflows list definition should not have changed 1`] = ` Object { "description": "Archive workflow instance in z/OSMF.", "name": "archive", + "summary": "Archive workflow instance in z/OSMF", "type": "group", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/create/__snapshots__/Create.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/create/__snapshots__/Create.definition.unit.test.ts.snap index 1412039601..ed7d5db11c 100644 --- a/packages/cli/__tests__/workflows/__unit__/create/__snapshots__/Create.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/create/__snapshots__/Create.definition.unit.test.ts.snap @@ -7,6 +7,7 @@ Object { ], "description": "Create a z/OSMF workflow on a z/OS system.", "name": "create", + "summary": "Create a z/OSMF workflow on a z/OS system", "type": "group", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap index 31f91ad413..3df1f17224 100644 --- a/packages/cli/__tests__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/create/dataset/__snapshots__/Dataset.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "wfds", ], - "description": "Create a z/OSMF workflow on a z/OS system using a Data set", + "description": "Create a z/OSMF workflow on a z/OS system using a data set.", "examples": Array [ Object { "description": "Create a workflow with name \\"testworkflow\\" using the data set \\"TESTID.WKFLOW\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF", @@ -30,7 +30,7 @@ Object { "aliases": Array [ "ds", ], - "description": "Data set that contains a workflow definiton.", + "description": "Data set that contains a workflow definition.", "name": "data-set", "required": true, "type": "string", @@ -130,6 +130,7 @@ Object { "zosmf", ], }, + "summary": "Create a z/OSMF workflow on a z/OS system using a data set", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap index 8be11b3c8b..a550bf8491 100644 --- a/packages/cli/__tests__/workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/create/localfile/__snapshots__/LocalFile.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "wflf", ], - "description": "Create a z/OSMF workflow on a z/OS system using a Local file", + "description": "Create a z/OSMF workflow on a z/OS system using a local file.", "examples": Array [ Object { "description": "Create a workflow with name \\"testworkflow\\" using the local file \\"TESTID_WKFLOW.xml\\" that contains the workflow definition xml on the system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF", @@ -18,7 +18,7 @@ Object { "aliases": Array [ "lf", ], - "description": "Local file that contains workflow definiton.", + "description": "Local file that contains workflow definition.", "name": "local-file", "required": true, "type": "string", @@ -107,7 +107,7 @@ Object { "aliases": Array [ "rd", ], - "description": "The remote uss directory where the files are to be uploaded. The directory has to exist", + "description": "The remote USS directory where the files are to be uploaded. The directory has to exist.", "name": "remote-directory", "required": false, "type": "string", @@ -137,6 +137,7 @@ Object { "zosmf", ], }, + "summary": "Create a z/OSMF workflow on a z/OS system using a local file", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap index 4630a020e0..b72deb81f0 100644 --- a/packages/cli/__tests__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/create/ussfile/__snapshots__/UssFile.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "wfuf", ], - "description": "Create a workflow instance in z/OSMF using a USS file", + "description": "Create a workflow instance in z/OSMF using a USS file.", "examples": Array [ Object { "description": "Create a workflow with name \\"testworkflow\\" using uss file \\"/path/workflow.xml\\" containing workflow definition, on system \\"TESTM1\\" with owner \\"OTHERID\\" and delete workflow with the same name if it already exist in z/OSMF", @@ -30,7 +30,7 @@ Object { "aliases": Array [ "uf", ], - "description": "Uss file that contains workflow definiton.", + "description": "USS file that contains workflow definition.", "name": "uss-file", "required": true, "type": "string", @@ -130,6 +130,7 @@ Object { "zosmf", ], }, + "summary": "Create a workflow instance in z/OSMF using a USS file", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap index 08eddc40cf..9776a46436 100644 --- a/packages/cli/__tests__/workflows/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/delete/__snapshots__/Delete.definition.unit.test.ts.snap @@ -7,6 +7,7 @@ Object { ], "description": "Delete an active workflow or an archived workflow from z/OSMF.", "name": "delete", + "summary": "Delete an active workflow or an archived workflow from z/OSMF", "type": "group", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/delete/deleteActiveWorkflow/__snapshots__/deleteActiveWorkflow.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/delete/deleteActiveWorkflow/__snapshots__/deleteActiveWorkflow.definition.unit.test.ts.snap index 3580b72123..aa837d38b3 100644 --- a/packages/cli/__tests__/workflows/__unit__/delete/deleteActiveWorkflow/__snapshots__/deleteActiveWorkflow.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/delete/deleteActiveWorkflow/__snapshots__/deleteActiveWorkflow.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "aw", ], - "description": "Delete an active workflow instance in z/OSMF", + "description": "Delete an active workflow instance in z/OSMF.", "examples": Array [ Object { "description": "To delete a workflow instance in z/OSMF with workflow key \\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\"", @@ -52,6 +52,7 @@ Object { "zosmf", ], }, + "summary": "Delete an active workflow instance in z/OSMF", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/delete/deleteArchivedWorkflow/__snapshots__/deleteArchivedWorkflow.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/delete/deleteArchivedWorkflow/__snapshots__/deleteArchivedWorkflow.definition.unit.test.ts.snap index 154745e69f..c1c443c036 100644 --- a/packages/cli/__tests__/workflows/__unit__/delete/deleteArchivedWorkflow/__snapshots__/deleteArchivedWorkflow.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/delete/deleteArchivedWorkflow/__snapshots__/deleteArchivedWorkflow.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "arw", ], - "description": "Delete an archived workflow from z/OSMF", + "description": "Delete an archived workflow from z/OSMF.", "examples": Array [ Object { "description": "To delete an archived workflow from z/OSMF with workflow key \\"d043b5f1-adab-48e7-b7c3-d41cd95fa4b0\\"", @@ -52,6 +52,7 @@ Object { "zosmf", ], }, + "summary": "Delete an archived workflow from z/OSMF", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap index c685737f27..6a960c9145 100644 --- a/packages/cli/__tests__/workflows/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap @@ -7,6 +7,7 @@ Object { ], "description": "List the z/OSMF workflows for a system or a sysplex with filter options.", "name": "list", + "summary": "List the z/OSMF workflows for a system or a sysplex with filter options", "type": "group", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/list/activeWorkflow/__snapshots__/ActiveWorkflows.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/list/activeWorkflow/__snapshots__/ActiveWorkflows.definition.unit.test.ts.snap index 01dca082c1..c0ab25c13d 100644 --- a/packages/cli/__tests__/workflows/__unit__/list/activeWorkflow/__snapshots__/ActiveWorkflows.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/list/activeWorkflow/__snapshots__/ActiveWorkflows.definition.unit.test.ts.snap @@ -7,7 +7,7 @@ Object { ], "description": "List active workflow instance(s) in z/OSMF. Multiple filters can be used together. -Omitting all options will list all workflows on the sysplex", +Omitting all options will list all workflows on the sysplex.", "examples": Array [ Object { "description": "List the workflow with name \\"testworkflow\\"", @@ -94,7 +94,7 @@ Omitting all options will list all workflows on the sysplex", "zosmf", ], }, - "summary": "List active workflow instance(s) in z/OSMF.", + "summary": "List active workflow instance(s) in z/OSMF", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/list/activeWorkflowDetails/__snapshots__/ActiveWorkflowDetails.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/list/activeWorkflowDetails/__snapshots__/ActiveWorkflowDetails.definition.unit.test.ts.snap index 02c816fb24..0f5af187c4 100644 --- a/packages/cli/__tests__/workflows/__unit__/list/activeWorkflowDetails/__snapshots__/ActiveWorkflowDetails.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/list/activeWorkflowDetails/__snapshots__/ActiveWorkflowDetails.definition.unit.test.ts.snap @@ -5,7 +5,7 @@ Object { "aliases": Array [ "awd", ], - "description": "Get the details of an active z/OSMF workflow", + "description": "Get the details of an active z/OSMF workflow.", "examples": Array [ Object { "description": "To list the details of an active workflow with key \\"7c62c790-0340-86b2-61ce618d8f8c\\" including its steps and variables", @@ -92,6 +92,7 @@ Object { "zosmf", ], }, + "summary": "Get the details of an active z/OSMF workflow", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/list/archivedWorkflows/__snapshots__/ArchivedWorkflows.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/list/archivedWorkflows/__snapshots__/ArchivedWorkflows.definition.unit.test.ts.snap index bc8edb4cc5..c90c54ce71 100644 --- a/packages/cli/__tests__/workflows/__unit__/list/archivedWorkflows/__snapshots__/ArchivedWorkflows.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/list/archivedWorkflows/__snapshots__/ArchivedWorkflows.definition.unit.test.ts.snap @@ -13,7 +13,7 @@ Object { "zosmf", ], }, - "summary": "List all archived workflows for a system.", + "summary": "List all archived workflows for a system", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/list/retrieveWorkflowDefinition/__snapshots__/RetrieveWorkflowDefinition.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/list/retrieveWorkflowDefinition/__snapshots__/RetrieveWorkflowDefinition.definition.unit.test.ts.snap index d10cd1f402..6e1a5ff287 100644 --- a/packages/cli/__tests__/workflows/__unit__/list/retrieveWorkflowDefinition/__snapshots__/RetrieveWorkflowDefinition.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/list/retrieveWorkflowDefinition/__snapshots__/RetrieveWorkflowDefinition.definition.unit.test.ts.snap @@ -50,6 +50,7 @@ Object { "zosmf", ], }, + "summary": "Retrieve the contents of a z/OSMF workflow definition from a z/OS system", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/start/__snapshots__/Start.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/start/__snapshots__/Start.definition.unit.test.ts.snap index dfe9bbd6af..b389b1f2ab 100644 --- a/packages/cli/__tests__/workflows/__unit__/start/__snapshots__/Start.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/start/__snapshots__/Start.definition.unit.test.ts.snap @@ -7,6 +7,7 @@ Object { ], "description": "Start a z/OSMF workflow on a z/OS system.", "name": "start", + "summary": "Start a z/OSMF workflow on a z/OS system", "type": "group", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/start/workflowFull/__snapshots__/WorkflowFull.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/start/workflowFull/__snapshots__/WorkflowFull.definition.unit.test.ts.snap index f59af1dd8f..d9da9d9c6e 100644 --- a/packages/cli/__tests__/workflows/__unit__/start/workflowFull/__snapshots__/WorkflowFull.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/start/workflowFull/__snapshots__/WorkflowFull.definition.unit.test.ts.snap @@ -86,6 +86,7 @@ leaveConflict: Automation is stopped. The user must resolve the conflict manuall "zosmf", ], }, + "summary": "Will run workflow from the beginning to the end or to the first manual step", "type": "command", } `; diff --git a/packages/cli/__tests__/workflows/__unit__/start/workflowStep/__snapshots__/WorkflowStep.definition.unit.test.ts.snap b/packages/cli/__tests__/workflows/__unit__/start/workflowStep/__snapshots__/WorkflowStep.definition.unit.test.ts.snap index 26ca830087..280ce00655 100644 --- a/packages/cli/__tests__/workflows/__unit__/start/workflowStep/__snapshots__/WorkflowStep.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/workflows/__unit__/start/workflowStep/__snapshots__/WorkflowStep.definition.unit.test.ts.snap @@ -95,6 +95,7 @@ leaveConflict: Automation is stopped. The user must resolve the conflict manuall "zosmf", ], }, + "summary": "Will run given step of workflow instance plus following steps if specified by --perform-following-steps option", "type": "command", } `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/compare/ds/__snapshots__/cli.files.compare.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/compare/ds/__snapshots__/cli.files.compare.ds.integration.test.ts.snap index 700ed4e2cd..544d610061 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/compare/ds/__snapshots__/cli.files.compare.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/compare/ds/__snapshots__/cli.files.compare.ds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Compare two data sets should display the help 1`] = ` DESCRIPTION ----------- - Compare content of two z/OS data sets on your terminal (stdout). + Compare the contents of two z/OS data sets in your terminal (stdout). USAGE ----- @@ -36,7 +36,7 @@ exports[`Compare two data sets should display the help 1`] = ` Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both - datasets are transferred in binary mode. + data sets are transferred in binary mode. --binary2 | --b2 (boolean) @@ -96,7 +96,7 @@ exports[`Compare two data sets should display the help 1`] = ` --browser-view | --bv (boolean) - Opens the diffs between two given files in browser + Opens the diffs between two given files in browser. --response-timeout | --rto (number) @@ -212,8 +212,8 @@ exports[`Compare two data sets should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Compare content of two z/OS data sets on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files compare data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName1\\\\t\\\\t (string)\\\\n\\\\n The name of the first data set you want to compare.\\\\n\\\\n dataSetName2\\\\t\\\\t (string)\\\\n\\\\n The name of the second data set you want to compare.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the content of the first data set in binary mode (no EBCDIC to ASCII\\\\n conversion). If binary mode is set and the binary2 flag is not set then both\\\\n datasets are transferred in binary mode.\\\\n\\\\n --binary2 | --b2 (boolean)\\\\n\\\\n Transfer the content of the second data set in binary mode.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the content of the first data set with encoding mode, which means that\\\\n data conversion is performed using the file encoding specified. If encoding mode\\\\n is set and the encoding2 flag is not set both data sets are transferred in\\\\n encoding mode.\\\\n\\\\n --encoding2 | --ec2 (string)\\\\n\\\\n Transfer the content of the second data set with encoding mode.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the content for the first data set in record mode, which means that no\\\\n data conversion is performed and the record length is prepended to the data. The\\\\n data transfer process returns each line as-is, without translation. No\\\\n delimiters are added between records. If encoding mode is set and the encoding2\\\\n flag is not set both data sets are transferred in encoding mode. This option\\\\n conflicts with binary mode.\\\\n\\\\n --record2 | --r2 (boolean)\\\\n\\\\n Transfer the content for the second data set in record mode. Conflicts with\\\\n binary2.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the first data set resides. You can use this\\\\n option at any time. However, the VOLSER is required only when the data set is\\\\n not cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --volume-serial2 | --vs2 (string)\\\\n\\\\n The volume serial (VOLSER) where the second data set resides.\\\\n\\\\n --seqnum | --sn (boolean)\\\\n\\\\n If you are comparing two files that contain sequence numbers, this option\\\\n controls if the sequences numbers are removed from the end of each string. The\\\\n default is to keep the sequence numbers. Use the --no-seqnum option to not\\\\n include them.\\\\n\\\\n Default value: true\\\\n\\\\n --context-lines | --cl (number)\\\\n\\\\n The number of context lines that display before and after detected non-matching\\\\n lines. By default all matching lines display. If you want to limit the amount of\\\\n data returned to only lines with differences use the context lines option to\\\\n reduce the matching lines to only those before and after non-matching lines.\\\\n Using the value of 0 strips all matching lines.\\\\n\\\\n --browser-view | --bv (boolean)\\\\n\\\\n Opens the diffs between two given files in browser\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\":\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\"\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\" without sequence numbers:\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\" --no-seqnum\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Compare the contents of two z/OS data sets in your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files compare data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName1\\\\t\\\\t (string)\\\\n\\\\n The name of the first data set you want to compare.\\\\n\\\\n dataSetName2\\\\t\\\\t (string)\\\\n\\\\n The name of the second data set you want to compare.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the content of the first data set in binary mode (no EBCDIC to ASCII\\\\n conversion). If binary mode is set and the binary2 flag is not set then both\\\\n data sets are transferred in binary mode.\\\\n\\\\n --binary2 | --b2 (boolean)\\\\n\\\\n Transfer the content of the second data set in binary mode.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the content of the first data set with encoding mode, which means that\\\\n data conversion is performed using the file encoding specified. If encoding mode\\\\n is set and the encoding2 flag is not set both data sets are transferred in\\\\n encoding mode.\\\\n\\\\n --encoding2 | --ec2 (string)\\\\n\\\\n Transfer the content of the second data set with encoding mode.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the content for the first data set in record mode, which means that no\\\\n data conversion is performed and the record length is prepended to the data. The\\\\n data transfer process returns each line as-is, without translation. No\\\\n delimiters are added between records. If encoding mode is set and the encoding2\\\\n flag is not set both data sets are transferred in encoding mode. This option\\\\n conflicts with binary mode.\\\\n\\\\n --record2 | --r2 (boolean)\\\\n\\\\n Transfer the content for the second data set in record mode. Conflicts with\\\\n binary2.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the first data set resides. You can use this\\\\n option at any time. However, the VOLSER is required only when the data set is\\\\n not cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --volume-serial2 | --vs2 (string)\\\\n\\\\n The volume serial (VOLSER) where the second data set resides.\\\\n\\\\n --seqnum | --sn (boolean)\\\\n\\\\n If you are comparing two files that contain sequence numbers, this option\\\\n controls if the sequences numbers are removed from the end of each string. The\\\\n default is to keep the sequence numbers. Use the --no-seqnum option to not\\\\n include them.\\\\n\\\\n Default value: true\\\\n\\\\n --context-lines | --cl (number)\\\\n\\\\n The number of context lines that display before and after detected non-matching\\\\n lines. By default all matching lines display. If you want to limit the amount of\\\\n data returned to only lines with differences use the context lines option to\\\\n reduce the matching lines to only those before and after non-matching lines.\\\\n Using the value of 0 strips all matching lines.\\\\n\\\\n --browser-view | --bv (boolean)\\\\n\\\\n Opens the diffs between two given files in browser.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\":\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\"\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\" without sequence numbers:\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\" --no-seqnum\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Compare content of two z/OS data sets on your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files compare data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName1\\\\t\\\\t (string)\\\\n\\\\n The name of the first data set you want to compare.\\\\n\\\\n dataSetName2\\\\t\\\\t (string)\\\\n\\\\n The name of the second data set you want to compare.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the content of the first data set in binary mode (no EBCDIC to ASCII\\\\n conversion). If binary mode is set and the binary2 flag is not set then both\\\\n datasets are transferred in binary mode.\\\\n\\\\n --binary2 | --b2 (boolean)\\\\n\\\\n Transfer the content of the second data set in binary mode.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the content of the first data set with encoding mode, which means that\\\\n data conversion is performed using the file encoding specified. If encoding mode\\\\n is set and the encoding2 flag is not set both data sets are transferred in\\\\n encoding mode.\\\\n\\\\n --encoding2 | --ec2 (string)\\\\n\\\\n Transfer the content of the second data set with encoding mode.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the content for the first data set in record mode, which means that no\\\\n data conversion is performed and the record length is prepended to the data. The\\\\n data transfer process returns each line as-is, without translation. No\\\\n delimiters are added between records. If encoding mode is set and the encoding2\\\\n flag is not set both data sets are transferred in encoding mode. This option\\\\n conflicts with binary mode.\\\\n\\\\n --record2 | --r2 (boolean)\\\\n\\\\n Transfer the content for the second data set in record mode. Conflicts with\\\\n binary2.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the first data set resides. You can use this\\\\n option at any time. However, the VOLSER is required only when the data set is\\\\n not cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --volume-serial2 | --vs2 (string)\\\\n\\\\n The volume serial (VOLSER) where the second data set resides.\\\\n\\\\n --seqnum | --sn (boolean)\\\\n\\\\n If you are comparing two files that contain sequence numbers, this option\\\\n controls if the sequences numbers are removed from the end of each string. The\\\\n default is to keep the sequence numbers. Use the --no-seqnum option to not\\\\n include them.\\\\n\\\\n Default value: true\\\\n\\\\n --context-lines | --cl (number)\\\\n\\\\n The number of context lines that display before and after detected non-matching\\\\n lines. By default all matching lines display. If you want to limit the amount of\\\\n data returned to only lines with differences use the context lines option to\\\\n reduce the matching lines to only those before and after non-matching lines.\\\\n Using the value of 0 strips all matching lines.\\\\n\\\\n --browser-view | --bv (boolean)\\\\n\\\\n Opens the diffs between two given files in browser\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\":\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\"\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\" without sequence numbers:\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\" --no-seqnum\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Compare the contents of two z/OS data sets in your terminal (stdout).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files compare data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName1\\\\t\\\\t (string)\\\\n\\\\n The name of the first data set you want to compare.\\\\n\\\\n dataSetName2\\\\t\\\\t (string)\\\\n\\\\n The name of the second data set you want to compare.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Transfer the content of the first data set in binary mode (no EBCDIC to ASCII\\\\n conversion). If binary mode is set and the binary2 flag is not set then both\\\\n data sets are transferred in binary mode.\\\\n\\\\n --binary2 | --b2 (boolean)\\\\n\\\\n Transfer the content of the second data set in binary mode.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Transfer the content of the first data set with encoding mode, which means that\\\\n data conversion is performed using the file encoding specified. If encoding mode\\\\n is set and the encoding2 flag is not set both data sets are transferred in\\\\n encoding mode.\\\\n\\\\n --encoding2 | --ec2 (string)\\\\n\\\\n Transfer the content of the second data set with encoding mode.\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Transfer the content for the first data set in record mode, which means that no\\\\n data conversion is performed and the record length is prepended to the data. The\\\\n data transfer process returns each line as-is, without translation. No\\\\n delimiters are added between records. If encoding mode is set and the encoding2\\\\n flag is not set both data sets are transferred in encoding mode. This option\\\\n conflicts with binary mode.\\\\n\\\\n --record2 | --r2 (boolean)\\\\n\\\\n Transfer the content for the second data set in record mode. Conflicts with\\\\n binary2.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the first data set resides. You can use this\\\\n option at any time. However, the VOLSER is required only when the data set is\\\\n not cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --volume-serial2 | --vs2 (string)\\\\n\\\\n The volume serial (VOLSER) where the second data set resides.\\\\n\\\\n --seqnum | --sn (boolean)\\\\n\\\\n If you are comparing two files that contain sequence numbers, this option\\\\n controls if the sequences numbers are removed from the end of each string. The\\\\n default is to keep the sequence numbers. Use the --no-seqnum option to not\\\\n include them.\\\\n\\\\n Default value: true\\\\n\\\\n --context-lines | --cl (number)\\\\n\\\\n The number of context lines that display before and after detected non-matching\\\\n lines. By default all matching lines display. If you want to limit the amount of\\\\n data returned to only lines with differences use the context lines option to\\\\n reduce the matching lines to only those before and after non-matching lines.\\\\n Using the value of 0 strips all matching lines.\\\\n\\\\n --browser-view | --bv (boolean)\\\\n\\\\n Opens the diffs between two given files in browser.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\":\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\"\\\\n\\\\n - Compare the contents of the data set members\\\\n \\\\\\"sys1.samplib(antptso)\\\\\\" and \\\\\\"sys1.samplib(antxtso)\\\\\\" without sequence numbers:\\\\n\\\\n $ zowe zos-files compare data-set \\\\\\"sys1.samplib(antptso)\\\\\\" \\\\\\"sys1.samplib(antxtso)\\\\\\" --no-seqnum\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/copy/ds/__snapshots__/cli.files.copy.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/copy/ds/__snapshots__/cli.files.copy.ds.integration.test.ts.snap index ecc02b8fa9..abf6986543 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/copy/ds/__snapshots__/cli.files.copy.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/copy/ds/__snapshots__/cli.files.copy.ds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Copy Data Set should display the help 1`] = ` DESCRIPTION ----------- - Copy a data set to another data set + Copy a data set to another data set. USAGE ----- @@ -36,7 +36,7 @@ exports[`Copy Data Set should display the help 1`] = ` --replace | --rep (boolean) Specify this option as true if you wish to replace like-named members in the - target dataset + target data set --response-timeout | --rto (number) @@ -171,8 +171,8 @@ exports[`Copy Data Set should display the help in json format 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to (data set must be\\\\n preallocated)\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace like-named members in the\\\\n target dataset\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' and replace like-named members:\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --replace\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to (data set must be\\\\n preallocated)\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace like-named members in the\\\\n target data set\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' and replace like-named members:\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --replace\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to (data set must be\\\\n preallocated)\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace like-named members in the\\\\n target dataset\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' and replace like-named members:\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --replace\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to (data set must be\\\\n preallocated)\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace like-named members in the\\\\n target data set\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\"\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET':\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\"\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' and replace like-named members:\\\\n\\\\n $ zowe zos-files copy data-set \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --replace\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/copy/dsclp/__snapshots__/cli.files.copy.dsclp.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/copy/dsclp/__snapshots__/cli.files.copy.dsclp.integration.test.ts.snap index db5d8aa541..a4b531b886 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/copy/dsclp/__snapshots__/cli.files.copy.dsclp.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/copy/dsclp/__snapshots__/cli.files.copy.dsclp.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Copy Data Set Cross LPAR should display the help 1`] = ` DESCRIPTION ----------- - Copy a data set to another data set on a specified LPAR + Copy a data set to another data set on a specified LPAR. USAGE ----- @@ -27,16 +27,16 @@ exports[`Copy Data Set Cross LPAR should display the help 1`] = ` toDataSetName (string) - The name of the data set that you want to copy to. If the dataset does not exist - it will be allocated automatically + The name of the data set that you want to copy to. If the data set does not + exist it will be allocated automatically OPTIONS ------- --replace | --rep (boolean) - Specify this option as true if you wish to replace the target dataset if it - already exists + Specify this option as true if you wish to replace the target data set if it + already exists. --target-data-class | --tdc (string) @@ -212,8 +212,8 @@ exports[`Copy Data Set Cross LPAR should display the help in json format 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-cross-lpar.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-cross-lpar | dsclp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set on a specified LPAR\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set-cross-lpar [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to. If the dataset does not exist\\\\n it will be allocated automatically\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace the target dataset if it\\\\n already exists\\\\n\\\\n --target-data-class | --tdc (string)\\\\n\\\\n The SMS data class to use for the allocation of the target data set.\\\\n\\\\n --target-host | --th (string)\\\\n\\\\n The target z/OSMF server host name.\\\\n\\\\n --target-management-class | --tmc (string)\\\\n\\\\n The SMS management class to use for the allocation of the target data set.\\\\n\\\\n --target-password | --tpw (string)\\\\n\\\\n The target z/OSMF password, which can be the same as your TSO password.\\\\n\\\\n --target-port | --tp (number)\\\\n\\\\n The target z/OSMF server port.\\\\n\\\\n --target-storage-class | --tsc (string)\\\\n\\\\n The SMS storage class to use for the allocation of the target data set.\\\\n\\\\n --target-token-type | --ttt (string)\\\\n\\\\n The value of the token to pass to the API for the target system.\\\\n\\\\n --target-token-value | --ttv (string)\\\\n\\\\n The type of token to get and use for the API for the target system.\\\\n\\\\n --target-user | --tu (string)\\\\n\\\\n The target z/OSMF user name, which can be the same as your TSO login.\\\\n\\\\n --target-volume-serial | --tvs | --target-volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the target data set to be placed.\\\\n\\\\n --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)\\\\n\\\\n The name of a z/OSMF profile to load for the target host.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host\\\\n using a zosmf profile:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET' using the --target-host, --target-user, and\\\\n --target-password options:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-host sys1.com --target-user user1 --target-password pass1\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-cross-lpar | dsclp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set on a specified LPAR.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set-cross-lpar [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to. If the data set does not\\\\n exist it will be allocated automatically\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace the target data set if it\\\\n already exists.\\\\n\\\\n --target-data-class | --tdc (string)\\\\n\\\\n The SMS data class to use for the allocation of the target data set.\\\\n\\\\n --target-host | --th (string)\\\\n\\\\n The target z/OSMF server host name.\\\\n\\\\n --target-management-class | --tmc (string)\\\\n\\\\n The SMS management class to use for the allocation of the target data set.\\\\n\\\\n --target-password | --tpw (string)\\\\n\\\\n The target z/OSMF password, which can be the same as your TSO password.\\\\n\\\\n --target-port | --tp (number)\\\\n\\\\n The target z/OSMF server port.\\\\n\\\\n --target-storage-class | --tsc (string)\\\\n\\\\n The SMS storage class to use for the allocation of the target data set.\\\\n\\\\n --target-token-type | --ttt (string)\\\\n\\\\n The value of the token to pass to the API for the target system.\\\\n\\\\n --target-token-value | --ttv (string)\\\\n\\\\n The type of token to get and use for the API for the target system.\\\\n\\\\n --target-user | --tu (string)\\\\n\\\\n The target z/OSMF user name, which can be the same as your TSO login.\\\\n\\\\n --target-volume-serial | --tvs | --target-volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the target data set to be placed.\\\\n\\\\n --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)\\\\n\\\\n The name of a z/OSMF profile to load for the target host.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host\\\\n using a zosmf profile:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET' using the --target-host, --target-user, and\\\\n --target-password options:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-host sys1.com --target-user user1 --target-password pass1\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-cross-lpar | dsclp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set on a specified LPAR\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set-cross-lpar [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to. If the dataset does not exist\\\\n it will be allocated automatically\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace the target dataset if it\\\\n already exists\\\\n\\\\n --target-data-class | --tdc (string)\\\\n\\\\n The SMS data class to use for the allocation of the target data set.\\\\n\\\\n --target-host | --th (string)\\\\n\\\\n The target z/OSMF server host name.\\\\n\\\\n --target-management-class | --tmc (string)\\\\n\\\\n The SMS management class to use for the allocation of the target data set.\\\\n\\\\n --target-password | --tpw (string)\\\\n\\\\n The target z/OSMF password, which can be the same as your TSO password.\\\\n\\\\n --target-port | --tp (number)\\\\n\\\\n The target z/OSMF server port.\\\\n\\\\n --target-storage-class | --tsc (string)\\\\n\\\\n The SMS storage class to use for the allocation of the target data set.\\\\n\\\\n --target-token-type | --ttt (string)\\\\n\\\\n The value of the token to pass to the API for the target system.\\\\n\\\\n --target-token-value | --ttv (string)\\\\n\\\\n The type of token to get and use for the API for the target system.\\\\n\\\\n --target-user | --tu (string)\\\\n\\\\n The target z/OSMF user name, which can be the same as your TSO login.\\\\n\\\\n --target-volume-serial | --tvs | --target-volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the target data set to be placed.\\\\n\\\\n --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)\\\\n\\\\n The name of a z/OSMF profile to load for the target host.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host\\\\n using a zosmf profile:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET' using the --target-host, --target-user, and\\\\n --target-password options:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-host sys1.com --target-user user1 --target-password pass1\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-cross-lpar | dsclp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Copy a data set to another data set on a specified LPAR.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files copy data-set-cross-lpar [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fromDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy from\\\\n\\\\n toDataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to copy to. If the data set does not\\\\n exist it will be allocated automatically\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --replace | --rep (boolean)\\\\n\\\\n Specify this option as true if you wish to replace the target data set if it\\\\n already exists.\\\\n\\\\n --target-data-class | --tdc (string)\\\\n\\\\n The SMS data class to use for the allocation of the target data set.\\\\n\\\\n --target-host | --th (string)\\\\n\\\\n The target z/OSMF server host name.\\\\n\\\\n --target-management-class | --tmc (string)\\\\n\\\\n The SMS management class to use for the allocation of the target data set.\\\\n\\\\n --target-password | --tpw (string)\\\\n\\\\n The target z/OSMF password, which can be the same as your TSO password.\\\\n\\\\n --target-port | --tp (number)\\\\n\\\\n The target z/OSMF server port.\\\\n\\\\n --target-storage-class | --tsc (string)\\\\n\\\\n The SMS storage class to use for the allocation of the target data set.\\\\n\\\\n --target-token-type | --ttt (string)\\\\n\\\\n The value of the token to pass to the API for the target system.\\\\n\\\\n --target-token-value | --ttv (string)\\\\n\\\\n The type of token to get and use for the API for the target system.\\\\n\\\\n --target-user | --tu (string)\\\\n\\\\n The target z/OSMF user name, which can be the same as your TSO login.\\\\n\\\\n --target-volume-serial | --tvs | --target-volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the target data set to be placed.\\\\n\\\\n --target-zosmf-profile | --t-zosmf-p | --target-zosmf-p (string)\\\\n\\\\n The name of a z/OSMF profile to load for the target host.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n named 'USER.TO.SET' using the --target-zosmf-p option to specify the target host\\\\n using a zosmf profile:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set named 'USER.FROM.SET' to the data set\\\\n member named 'USER.TO.SET(MEM2)':\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET\\\\\\" \\\\\\"USER.TO.SET(mem2)\\\\\\" --target-zosmf-p SYS1\\\\n\\\\n - Copy the data set member named 'USER.FROM.SET(MEM1)' to the\\\\n data set named 'USER.TO.SET' using the --target-host, --target-user, and\\\\n --target-password options:\\\\n\\\\n $ zowe zos-files copy data-set-cross-lpar \\\\\\"USER.FROM.SET(mem1)\\\\\\" \\\\\\"USER.TO.SET\\\\\\" --target-host sys1.com --target-user user1 --target-password pass1\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/binaryPds/__snapshots__/cli.files.create.dataset.binary.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/binaryPds/__snapshots__/cli.files.create.dataset.binary.integration.test.ts.snap index be73225861..d45b66effb 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/binaryPds/__snapshots__/cli.files.create.dataset.binary.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/binaryPds/__snapshots__/cli.files.create.dataset.binary.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create Binary Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create executable data sets + Create executable data sets. USAGE ----- @@ -210,8 +210,8 @@ exports[`Create Binary Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-binary.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-binary | bin\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create executable data sets\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-binary [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 27998\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 10\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: U\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 27998\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty binary partitioned data set (PDS) with\\\\n default parameters:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET\\\\n\\\\n - Create an empty binary PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-binary | bin\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create executable data sets.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-binary [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 27998\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 10\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: U\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 27998\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty binary partitioned data set (PDS) with\\\\n default parameters:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET\\\\n\\\\n - Create an empty binary PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-binary | bin\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create executable data sets\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-binary [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 27998\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 10\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: U\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 27998\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty binary partitioned data set (PDS) with\\\\n default parameters:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET\\\\n\\\\n - Create an empty binary PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-binary | bin\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create executable data sets.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-binary [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 27998\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 10\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: U\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 27998\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty binary partitioned data set (PDS) with\\\\n default parameters:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET\\\\n\\\\n - Create an empty binary PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-binary NEW.BINARY.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/cPds/__snapshots__/cli.files.create.dataset.c.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/cPds/__snapshots__/cli.files.create.dataset.c.integration.test.ts.snap index 3e5189ee85..7bbd90d0f9 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/cPds/__snapshots__/cli.files.create.dataset.c.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/cPds/__snapshots__/cli.files.create.dataset.c.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create C Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create data sets for C code programming + Create data sets for C code programming. USAGE ----- @@ -209,8 +209,8 @@ exports[`Create C Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-c.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-c | dsc\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create data sets for C code programming\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-c [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 32760\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: VB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 260\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty C code PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET\\\\n\\\\n - Create an empty C code PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-c | dsc\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create data sets for C code programming.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-c [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 32760\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: VB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 260\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty C code PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET\\\\n\\\\n - Create an empty C code PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-c | dsc\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create data sets for C code programming\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-c [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 32760\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: VB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 260\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty C code PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET\\\\n\\\\n - Create an empty C code PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-c | dsc\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create data sets for C code programming.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-c [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 32760\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: VB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 260\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty C code PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET\\\\n\\\\n - Create an empty C code PDSE using data set type LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-c NEW.CCODE.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/classicPds/__snapshots__/cli.files.create.dataset.classic.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/classicPds/__snapshots__/cli.files.create.dataset.classic.integration.test.ts.snap index c44823b2de..ae670dfca8 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/classicPds/__snapshots__/cli.files.create.dataset.classic.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/classicPds/__snapshots__/cli.files.create.dataset.classic.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create Classic Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create classic data sets (JCL, HLASM, CBL, etc...) + Create classic data sets (JCL, HLASM, CBL, etc...). USAGE ----- @@ -210,8 +210,8 @@ exports[`Create Classic Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-classic.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-classic | classic\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create classic data sets (JCL, HLASM, CBL, etc...)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-classic [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty z/OS 'classic' PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET\\\\n\\\\n - Create an empty z/OS 'classic' PDSE using data set type\\\\n LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-classic | classic\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create classic data sets (JCL, HLASM, CBL, etc...).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-classic [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty z/OS 'classic' PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET\\\\n\\\\n - Create an empty z/OS 'classic' PDSE using data set type\\\\n LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-classic | classic\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create classic data sets (JCL, HLASM, CBL, etc...)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-classic [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty z/OS 'classic' PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET\\\\n\\\\n - Create an empty z/OS 'classic' PDSE using data set type\\\\n LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-classic | classic\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create classic data sets (JCL, HLASM, CBL, etc...).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-classic [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-type | --dst | --dsntype (string)\\\\n\\\\n The data set type (BASIC, EXTPREF, EXTREQ, HFS, LARGE, PDS, LIBRARY, PIPE)\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n Default value: 25\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty z/OS 'classic' PDS with default parameters:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET\\\\n\\\\n - Create an empty z/OS 'classic' PDSE using data set type\\\\n LIBRARY:\\\\n\\\\n $ zowe zos-files create data-set-classic NEW.CLASSIC.DATASET --data-set-type LIBRARY\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/ds/__snapshots__/cli.files.create.dataset.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/ds/__snapshots__/cli.files.create.dataset.integration.test.ts.snap index bb597a9da4..6239c6d61c 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/ds/__snapshots__/cli.files.create.dataset.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/ds/__snapshots__/cli.files.create.dataset.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create data sets based on the properties of an existing data set + Create data sets based on the properties of an existing data set. USAGE ----- diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/ps/__snapshots__/cli.files.create.dataset.ps.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/ps/__snapshots__/cli.files.create.dataset.ps.integration.test.ts.snap index b5b486b9ee..0377d79850 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/ps/__snapshots__/cli.files.create.dataset.ps.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/ps/__snapshots__/cli.files.create.dataset.ps.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create Physical Sequential Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create physical sequential data sets (PS) + Create physical sequential data sets (PS). USAGE ----- @@ -200,8 +200,8 @@ exports[`Create Physical Sequential Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-sequential.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-sequential | ps\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create physical sequential data sets (PS)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-sequential [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty physical sequential data set with default\\\\n parameters:\\\\n\\\\n $ zowe zos-files create data-set-sequential NEW.PS.DATASET\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-sequential | ps\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create physical sequential data sets (PS).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-sequential [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty physical sequential data set with default\\\\n parameters:\\\\n\\\\n $ zowe zos-files create data-set-sequential NEW.PS.DATASET\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-sequential | ps\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create physical sequential data sets (PS)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-sequential [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty physical sequential data set with default\\\\n parameters:\\\\n\\\\n $ zowe zos-files create data-set-sequential NEW.PS.DATASET\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-sequential | ps\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create physical sequential data sets (PS).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-sequential [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to create\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --block-size | --bs | --blksize (number)\\\\n\\\\n The block size for the data set (for example, 6160)\\\\n\\\\n Default value: 6160\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --device-type | --dt | --unit (string)\\\\n\\\\n The device type, also known as 'unit'\\\\n\\\\n --directory-blocks | --db | --dirblks (number)\\\\n\\\\n The number of directory blocks (for example, 25)\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --primary-space | --ps (number)\\\\n\\\\n The primary space allocation (for example, 5)\\\\n\\\\n Default value: 1\\\\n\\\\n --record-format | --rf | --recfm (string)\\\\n\\\\n The record format for the data set (for example, FB for \\\\\\"Fixed Block\\\\\\")\\\\n\\\\n Default value: FB\\\\n\\\\n --record-length | --rl | --lrecl (number)\\\\n\\\\n The logical record length. Analogous to the length of a line (for example, 80)\\\\n\\\\n Default value: 80\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The secondary space allocation (for example, 1)\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The size of the data set (specified as nCYL or nTRK - where n is the number of\\\\n cylinders or tracks). Sets the primary allocation (the secondary allocation\\\\n becomes ~10% of the primary).\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volume-serial | --vs | --volser (string)\\\\n\\\\n The volume serial (VOLSER) on which you want the data set to be placed. A VOLSER\\\\n is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create an empty physical sequential data set with default\\\\n parameters:\\\\n\\\\n $ zowe zos-files create data-set-sequential NEW.PS.DATASET\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/create/vsam/__snapshots__/cli.files.create.dataset.vsam.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/create/vsam/__snapshots__/cli.files.create.dataset.vsam.integration.test.ts.snap index acb5a0fb0e..05ea885e85 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/create/vsam/__snapshots__/cli.files.create.dataset.vsam.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/create/vsam/__snapshots__/cli.files.create.dataset.vsam.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Create VSAM Data Set should display the help 1`] = ` DESCRIPTION ----------- - Create a VSAM cluster + Create a VSAM cluster. USAGE ----- @@ -23,7 +23,7 @@ exports[`Create VSAM Data Set should display the help 1`] = ` dataSetName (string) - The name of the dataset in which to create a VSAM cluster + The name of the data set in which to create a VSAM cluster OPTIONS ------- @@ -207,8 +207,8 @@ exports[`Create VSAM Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-vsam.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a VSAM cluster\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the dataset in which to create a VSAM cluster\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-organization | --dso | --dsorg (string)\\\\n\\\\n The data set organization.\\\\n\\\\n Default value: INDEXED\\\\n Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --retain-for | --rf (number)\\\\n\\\\n The number of days that the VSAM cluster will be retained on the system. You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is\\\\n specified.\\\\n\\\\n --retain-to | --rt (string)\\\\n\\\\n The earliest date that a command without the PURGE parameter can delete an\\\\n entry. Specify the expiration date in the form yyyyddd, where yyyy is a\\\\n four-digit year (maximum value: 2155) and ddd is the three-digit day of the year\\\\n from 001 through 365 (for non-leap years) or 366 (for leap years). You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is used.\\\\n You cannot specify both the 'retain-to' and 'retain-for' options.\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The number of items for the secondary space allocation (for example, 840). The\\\\n type of item allocated is the same as the type used for the '--size' option. If\\\\n you do not specify a secondary allocation, a value of ~10% of the primary\\\\n allocation is used.\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The primary size to allocate for the VSAM cluster. Specify size as the number of\\\\n items to allocate (nItems). You specify the type of item by keyword.\\\\n\\\\n Default value: 840KB\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volumes | -v (string)\\\\n\\\\n The storage volumes on which to allocate a VSAM cluster. Specify a single volume\\\\n by its volume serial (VOLSER). To specify more than one volume, enclose the\\\\n option in double-quotes and separate each VOLSER with a space. You must specify\\\\n the volumes option when your cluster is not SMS-managed.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\" using\\\\n default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME\\\\n\\\\n - Create a 5 MB LINEAR VSAM data set named\\\\n \\\\\\"SOME.DATA.SET.NAME\\\\\\" with 1 MB of secondary space. Show the properties of the\\\\n data set when it is created:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\", which is\\\\n retained for 100 days:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100 \\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a VSAM cluster.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set in which to create a VSAM cluster\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-organization | --dso | --dsorg (string)\\\\n\\\\n The data set organization.\\\\n\\\\n Default value: INDEXED\\\\n Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --retain-for | --rf (number)\\\\n\\\\n The number of days that the VSAM cluster will be retained on the system. You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is\\\\n specified.\\\\n\\\\n --retain-to | --rt (string)\\\\n\\\\n The earliest date that a command without the PURGE parameter can delete an\\\\n entry. Specify the expiration date in the form yyyyddd, where yyyy is a\\\\n four-digit year (maximum value: 2155) and ddd is the three-digit day of the year\\\\n from 001 through 365 (for non-leap years) or 366 (for leap years). You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is used.\\\\n You cannot specify both the 'retain-to' and 'retain-for' options.\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The number of items for the secondary space allocation (for example, 840). The\\\\n type of item allocated is the same as the type used for the '--size' option. If\\\\n you do not specify a secondary allocation, a value of ~10% of the primary\\\\n allocation is used.\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The primary size to allocate for the VSAM cluster. Specify size as the number of\\\\n items to allocate (nItems). You specify the type of item by keyword.\\\\n\\\\n Default value: 840KB\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volumes | -v (string)\\\\n\\\\n The storage volumes on which to allocate a VSAM cluster. Specify a single volume\\\\n by its volume serial (VOLSER). To specify more than one volume, enclose the\\\\n option in double-quotes and separate each VOLSER with a space. You must specify\\\\n the volumes option when your cluster is not SMS-managed.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\" using\\\\n default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME\\\\n\\\\n - Create a 5 MB LINEAR VSAM data set named\\\\n \\\\\\"SOME.DATA.SET.NAME\\\\\\" with 1 MB of secondary space. Show the properties of the\\\\n data set when it is created:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\", which is\\\\n retained for 100 days:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100 \\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a VSAM cluster\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the dataset in which to create a VSAM cluster\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-organization | --dso | --dsorg (string)\\\\n\\\\n The data set organization.\\\\n\\\\n Default value: INDEXED\\\\n Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --retain-for | --rf (number)\\\\n\\\\n The number of days that the VSAM cluster will be retained on the system. You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is\\\\n specified.\\\\n\\\\n --retain-to | --rt (string)\\\\n\\\\n The earliest date that a command without the PURGE parameter can delete an\\\\n entry. Specify the expiration date in the form yyyyddd, where yyyy is a\\\\n four-digit year (maximum value: 2155) and ddd is the three-digit day of the year\\\\n from 001 through 365 (for non-leap years) or 366 (for leap years). You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is used.\\\\n You cannot specify both the 'retain-to' and 'retain-for' options.\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The number of items for the secondary space allocation (for example, 840). The\\\\n type of item allocated is the same as the type used for the '--size' option. If\\\\n you do not specify a secondary allocation, a value of ~10% of the primary\\\\n allocation is used.\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The primary size to allocate for the VSAM cluster. Specify size as the number of\\\\n items to allocate (nItems). You specify the type of item by keyword.\\\\n\\\\n Default value: 840KB\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volumes | -v (string)\\\\n\\\\n The storage volumes on which to allocate a VSAM cluster. Specify a single volume\\\\n by its volume serial (VOLSER). To specify more than one volume, enclose the\\\\n option in double-quotes and separate each VOLSER with a space. You must specify\\\\n the volumes option when your cluster is not SMS-managed.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\" using\\\\n default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME\\\\n\\\\n - Create a 5 MB LINEAR VSAM data set named\\\\n \\\\\\"SOME.DATA.SET.NAME\\\\\\" with 1 MB of secondary space. Show the properties of the\\\\n data set when it is created:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\", which is\\\\n retained for 100 days:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100 \\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Create a VSAM cluster.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files create data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set in which to create a VSAM cluster\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Show the full allocation attributes\\\\n\\\\n --data-class | --dc (string)\\\\n\\\\n The SMS data class to use for the allocation\\\\n\\\\n --data-set-organization | --dso | --dsorg (string)\\\\n\\\\n The data set organization.\\\\n\\\\n Default value: INDEXED\\\\n Allowed values: INDEXED, IXD, LINEAR, LIN, NONINDEXED, NIXD, NUMBERED, NUMD, ZFS\\\\n\\\\n --management-class | --mc (string)\\\\n\\\\n The SMS management class to use for the allocation\\\\n\\\\n --retain-for | --rf (number)\\\\n\\\\n The number of days that the VSAM cluster will be retained on the system. You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is\\\\n specified.\\\\n\\\\n --retain-to | --rt (string)\\\\n\\\\n The earliest date that a command without the PURGE parameter can delete an\\\\n entry. Specify the expiration date in the form yyyyddd, where yyyy is a\\\\n four-digit year (maximum value: 2155) and ddd is the three-digit day of the year\\\\n from 001 through 365 (for non-leap years) or 366 (for leap years). You can\\\\n delete the cluster at any time when neither retain-for nor retain-to is used.\\\\n You cannot specify both the 'retain-to' and 'retain-for' options.\\\\n\\\\n --secondary-space | --ss (number)\\\\n\\\\n The number of items for the secondary space allocation (for example, 840). The\\\\n type of item allocated is the same as the type used for the '--size' option. If\\\\n you do not specify a secondary allocation, a value of ~10% of the primary\\\\n allocation is used.\\\\n\\\\n --size | --sz (string)\\\\n\\\\n The primary size to allocate for the VSAM cluster. Specify size as the number of\\\\n items to allocate (nItems). You specify the type of item by keyword.\\\\n\\\\n Default value: 840KB\\\\n\\\\n --storage-class | --sc (string)\\\\n\\\\n The SMS storage class to use for the allocation\\\\n\\\\n --volumes | -v (string)\\\\n\\\\n The storage volumes on which to allocate a VSAM cluster. Specify a single volume\\\\n by its volume serial (VOLSER). To specify more than one volume, enclose the\\\\n option in double-quotes and separate each VOLSER with a space. You must specify\\\\n the volumes option when your cluster is not SMS-managed.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\" using\\\\n default values of INDEXED, 840 KB primary storage and 84 KB secondary storage:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME\\\\n\\\\n - Create a 5 MB LINEAR VSAM data set named\\\\n \\\\\\"SOME.DATA.SET.NAME\\\\\\" with 1 MB of secondary space. Show the properties of the\\\\n data set when it is created:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --data-set-organization LINEAR --size 5MB --secondary-space 1 --attributes\\\\n\\\\n - Create a VSAM data set named \\\\\\"SOME.DATA.SET.NAME\\\\\\", which is\\\\n retained for 100 days:\\\\n\\\\n $ zowe zos-files create data-set-vsam SOME.DATA.SET.NAME --retain-for 100 \\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/delete/ds/__snapshots__/cli.files.delete.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/delete/ds/__snapshots__/cli.files.delete.ds.integration.test.ts.snap index a76639ec83..52ad2259ab 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/delete/ds/__snapshots__/cli.files.delete.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/delete/ds/__snapshots__/cli.files.delete.ds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Delete Data Set should display the help 1`] = ` DESCRIPTION ----------- - Delete a data set or data set member permanently + Delete a data set or data set member permanently. USAGE ----- @@ -152,8 +152,8 @@ exports[`Delete Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a data set or data set member permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the data set permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --volume | --vol (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. The option is required\\\\n only when the data set is not catalogued on the system.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the data set named 'ibmuser.cntl':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl\\\\\\" -f\\\\n\\\\n - Delete the data set member named 'ibmuser.cntl(mem)':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl(mem)\\\\\\" -f\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a data set or data set member permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the data set permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --volume | --vol (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. The option is required\\\\n only when the data set is not catalogued on the system.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the data set named 'ibmuser.cntl':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl\\\\\\" -f\\\\n\\\\n - Delete the data set member named 'ibmuser.cntl(mem)':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl(mem)\\\\\\" -f\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a data set or data set member permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the data set permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --volume | --vol (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. The option is required\\\\n only when the data set is not catalogued on the system.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the data set named 'ibmuser.cntl':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl\\\\\\" -f\\\\n\\\\n - Delete the data set member named 'ibmuser.cntl(mem)':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl(mem)\\\\\\" -f\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a data set or data set member permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the data set permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --volume | --vol (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. The option is required\\\\n only when the data set is not catalogued on the system.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the data set named 'ibmuser.cntl':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl\\\\\\" -f\\\\n\\\\n - Delete the data set member named 'ibmuser.cntl(mem)':\\\\n\\\\n $ zowe zos-files delete data-set \\\\\\"ibmuser.cntl(mem)\\\\\\" -f\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/delete/uss/__snapshots__/cli.files.delete.uss.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/delete/uss/__snapshots__/cli.files.delete.uss.integration.test.ts.snap index 7306067258..562158c9b3 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/delete/uss/__snapshots__/cli.files.delete.uss.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/delete/uss/__snapshots__/cli.files.delete.uss.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Delete USS File should display the help 1`] = ` DESCRIPTION ----------- - Delete a Unix Systems Services (USS) File or directory permanently + Delete a Unix Systems Services (USS) file or directory permanently. USAGE ----- @@ -157,8 +157,8 @@ exports[`Delete USS File should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: uss-file.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a Unix Systems Services (USS) File or directory permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fileName\\\\t\\\\t (string)\\\\n\\\\n The name of the file or directory that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the file or directory\\\\n permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Delete directories recursively.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the empty directory '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -f\\\\n\\\\n - Delete the file named '/a/ibmuser/my_text.txt':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases/my_text.txt\\\\\\" -f\\\\n\\\\n - Recursively delete the directory named\\\\n '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -rf\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a Unix Systems Services (USS) file or directory permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fileName\\\\t\\\\t (string)\\\\n\\\\n The name of the file or directory that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the file or directory\\\\n permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Delete directories recursively.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the empty directory '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -f\\\\n\\\\n - Delete the file named '/a/ibmuser/my_text.txt':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases/my_text.txt\\\\\\" -f\\\\n\\\\n - Recursively delete the directory named\\\\n '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -rf\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a Unix Systems Services (USS) File or directory permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fileName\\\\t\\\\t (string)\\\\n\\\\n The name of the file or directory that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the file or directory\\\\n permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Delete directories recursively.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the empty directory '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -f\\\\n\\\\n - Delete the file named '/a/ibmuser/my_text.txt':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases/my_text.txt\\\\\\" -f\\\\n\\\\n - Recursively delete the directory named\\\\n '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -rf\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a Unix Systems Services (USS) file or directory permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n fileName\\\\t\\\\t (string)\\\\n\\\\n The name of the file or directory that you want to delete\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the file or directory\\\\n permanently.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Delete directories recursively.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the empty directory '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -f\\\\n\\\\n - Delete the file named '/a/ibmuser/my_text.txt':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases/my_text.txt\\\\\\" -f\\\\n\\\\n - Recursively delete the directory named\\\\n '/u/ibmuser/testcases':\\\\n\\\\n $ zowe zos-files delete uss-file \\\\\\"/a/ibmuser/testcases\\\\\\" -rf\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/delete/vsam/__snapshots__/cli.files.delete.vsam.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/delete/vsam/__snapshots__/cli.files.delete.vsam.integration.test.ts.snap index d95a7b28c3..2d5e2e8ee0 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/delete/vsam/__snapshots__/cli.files.delete.vsam.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/delete/vsam/__snapshots__/cli.files.delete.vsam.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Delete VSAM Data Set should display delete vsam help 1`] = ` DESCRIPTION ----------- - Delete a VSAM cluster permanently + Delete a VSAM cluster permanently. USAGE ----- @@ -174,8 +174,8 @@ exports[`Delete VSAM Data Set should display delete vsam help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set-vsam.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a VSAM cluster permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the VSAM cluster that you want to delete\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --erase | -e (boolean)\\\\n\\\\n Specify this option to overwrite the data component for the cluster with binary\\\\n zeros. This option is ignored if the NOERASE attribute was specified when the\\\\n cluster was defined or altered.\\\\n\\\\n Default value: false\\\\n\\\\n --purge | -p (boolean)\\\\n\\\\n Specify this option to delete the VSAM cluster regardless of its retention\\\\n period or date.\\\\n\\\\n Default value: false\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the VSAM cluster\\\\n permanently.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the VSAM data set named 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f\\\\n\\\\n - Delete all expired VSAM data sets that match\\\\n 'ibmuser.AAA.**.FFF':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.AAA.**.FFF\\\\\\" -f\\\\n\\\\n - Delete a non-expired VSAM data set named\\\\n 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --purge\\\\n\\\\n - Delete an expired VSAM data set named 'ibmuser.cntl.vsam'\\\\n by overwriting the components with zeros:\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --erase\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a VSAM cluster permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the VSAM cluster that you want to delete\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --erase | -e (boolean)\\\\n\\\\n Specify this option to overwrite the data component for the cluster with binary\\\\n zeros. This option is ignored if the NOERASE attribute was specified when the\\\\n cluster was defined or altered.\\\\n\\\\n Default value: false\\\\n\\\\n --purge | -p (boolean)\\\\n\\\\n Specify this option to delete the VSAM cluster regardless of its retention\\\\n period or date.\\\\n\\\\n Default value: false\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the VSAM cluster\\\\n permanently.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the VSAM data set named 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f\\\\n\\\\n - Delete all expired VSAM data sets that match\\\\n 'ibmuser.AAA.**.FFF':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.AAA.**.FFF\\\\\\" -f\\\\n\\\\n - Delete a non-expired VSAM data set named\\\\n 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --purge\\\\n\\\\n - Delete an expired VSAM data set named 'ibmuser.cntl.vsam'\\\\n by overwriting the components with zeros:\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --erase\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a VSAM cluster permanently\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the VSAM cluster that you want to delete\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --erase | -e (boolean)\\\\n\\\\n Specify this option to overwrite the data component for the cluster with binary\\\\n zeros. This option is ignored if the NOERASE attribute was specified when the\\\\n cluster was defined or altered.\\\\n\\\\n Default value: false\\\\n\\\\n --purge | -p (boolean)\\\\n\\\\n Specify this option to delete the VSAM cluster regardless of its retention\\\\n period or date.\\\\n\\\\n Default value: false\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the VSAM cluster\\\\n permanently.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the VSAM data set named 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f\\\\n\\\\n - Delete all expired VSAM data sets that match\\\\n 'ibmuser.AAA.**.FFF':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.AAA.**.FFF\\\\\\" -f\\\\n\\\\n - Delete a non-expired VSAM data set named\\\\n 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --purge\\\\n\\\\n - Delete an expired VSAM data set named 'ibmuser.cntl.vsam'\\\\n by overwriting the components with zeros:\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --erase\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set-vsam | vsam\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a VSAM cluster permanently.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files delete data-set-vsam [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the VSAM cluster that you want to delete\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --erase | -e (boolean)\\\\n\\\\n Specify this option to overwrite the data component for the cluster with binary\\\\n zeros. This option is ignored if the NOERASE attribute was specified when the\\\\n cluster was defined or altered.\\\\n\\\\n Default value: false\\\\n\\\\n --purge | -p (boolean)\\\\n\\\\n Specify this option to delete the VSAM cluster regardless of its retention\\\\n period or date.\\\\n\\\\n Default value: false\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n REQUIRED OPTIONS\\\\n ----------------\\\\n\\\\n --for-sure | -f (boolean)\\\\n\\\\n Specify this option to confirm that you want to delete the VSAM cluster\\\\n permanently.\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete the VSAM data set named 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f\\\\n\\\\n - Delete all expired VSAM data sets that match\\\\n 'ibmuser.AAA.**.FFF':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.AAA.**.FFF\\\\\\" -f\\\\n\\\\n - Delete a non-expired VSAM data set named\\\\n 'ibmuser.cntl.vsam':\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --purge\\\\n\\\\n - Delete an expired VSAM data set named 'ibmuser.cntl.vsam'\\\\n by overwriting the components with zeros:\\\\n\\\\n $ zowe zos-files delete data-set-vsam \\\\\\"ibmuser.cntl.vsam\\\\\\" -f --erase\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/download/am/__snapshots__/cli.files.download.am.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/download/am/__snapshots__/cli.files.download.am.integration.test.ts.snap index 1938d38119..19ff35a710 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/download/am/__snapshots__/cli.files.download.am.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/download/am/__snapshots__/cli.files.download.am.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Download All Member should display the help 1`] = ` DESCRIPTION ----------- - Download all members from a partitioned data set to a local folder + Download all members from a partitioned data set to a local folder. USAGE ----- @@ -54,7 +54,7 @@ exports[`Download All Member should display the help 1`] = ` --fail-fast | --ff (boolean) - Set this option to false to continue downloading dataset members if one or more + Set this option to false to continue downloading data set members if one or more fail. Default value: true @@ -75,7 +75,7 @@ exports[`Download All Member should display the help 1`] = ` --preserve-original-letter-case | --po (boolean) Specifies if the automatically generated directories and files use the original - letter case + letter case. Default value: false @@ -206,8 +206,8 @@ exports[`Download All Member should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: all-members.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n all-members | am\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all members from a partitioned data set to a local folder\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download all-members [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set from which you want to download members\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading dataset members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.loadlib\\\\\\" in\\\\n binary mode to the directory \\\\\\"loadlib/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.loadlib\\\\\\" -b -d loadlib\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.cntl\\\\\\" in text\\\\n mode to the directory \\\\\\"jcl/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.cntl\\\\\\" -d jcl\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n all-members | am\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all members from a partitioned data set to a local folder.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download all-members [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set from which you want to download members\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading data set members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.loadlib\\\\\\" in\\\\n binary mode to the directory \\\\\\"loadlib/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.loadlib\\\\\\" -b -d loadlib\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.cntl\\\\\\" in text\\\\n mode to the directory \\\\\\"jcl/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.cntl\\\\\\" -d jcl\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n all-members | am\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all members from a partitioned data set to a local folder\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download all-members [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set from which you want to download members\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading dataset members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.loadlib\\\\\\" in\\\\n binary mode to the directory \\\\\\"loadlib/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.loadlib\\\\\\" -b -d loadlib\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.cntl\\\\\\" in text\\\\n mode to the directory \\\\\\"jcl/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.cntl\\\\\\" -d jcl\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n all-members | am\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all members from a partitioned data set to a local folder.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download all-members [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set from which you want to download members\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading data set members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.loadlib\\\\\\" in\\\\n binary mode to the directory \\\\\\"loadlib/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.loadlib\\\\\\" -b -d loadlib\\\\n\\\\n - Download the members of the data set \\\\\\"ibmuser.cntl\\\\\\" in text\\\\n mode to the directory \\\\\\"jcl/\\\\\\":\\\\n\\\\n $ zowe zos-files download all-members \\\\\\"ibmuser.cntl\\\\\\" -d jcl\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/download/ds/__snapshots__/cli.files.download.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/download/ds/__snapshots__/cli.files.download.ds.integration.test.ts.snap index 3493afb3ab..d0b9aa7fe3 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/download/ds/__snapshots__/cli.files.download.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/download/ds/__snapshots__/cli.files.download.ds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Download Data Set should display the help 1`] = ` DESCRIPTION ----------- - Download content from a z/OS data set to a local file + Download content from a z/OS data set to a local file. USAGE ----- @@ -53,7 +53,7 @@ exports[`Download Data Set should display the help 1`] = ` --preserve-original-letter-case | --po (boolean) Specifies if the automatically generated directories and files use the original - letter case + letter case. Default value: false @@ -179,8 +179,8 @@ exports[`Download Data Set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a z/OS data set to a local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the data set \\\\\\"ibmuser.loadlib(main)\\\\\\" in binary\\\\n mode to the local file \\\\\\"main.obj\\\\\\":\\\\n\\\\n $ zowe zos-files download data-set \\\\\\"ibmuser.loadlib(main)\\\\\\" -b -f main.obj\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a z/OS data set to a local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the data set \\\\\\"ibmuser.loadlib(main)\\\\\\" in binary\\\\n mode to the local file \\\\\\"main.obj\\\\\\":\\\\n\\\\n $ zowe zos-files download data-set \\\\\\"ibmuser.loadlib(main)\\\\\\" -b -f main.obj\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a z/OS data set to a local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the data set \\\\\\"ibmuser.loadlib(main)\\\\\\" in binary\\\\n mode to the local file \\\\\\"main.obj\\\\\\":\\\\n\\\\n $ zowe zos-files download data-set \\\\\\"ibmuser.loadlib(main)\\\\\\" -b -f main.obj\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a z/OS data set to a local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set that you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the data set \\\\\\"ibmuser.loadlib(main)\\\\\\" in binary\\\\n mode to the local file \\\\\\"main.obj\\\\\\":\\\\n\\\\n $ zowe zos-files download data-set \\\\\\"ibmuser.loadlib(main)\\\\\\" -b -f main.obj\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/download/dsm/__snapshots__/cli.files.download.dsm.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/download/dsm/__snapshots__/cli.files.download.dsm.integration.test.ts.snap index e3da90050c..67193449e7 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/download/dsm/__snapshots__/cli.files.download.dsm.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/download/dsm/__snapshots__/cli.files.download.dsm.integration.test.ts.snap @@ -79,7 +79,7 @@ exports[`Download Dataset Matching should display the help 1`] = ` --fail-fast | --ff (boolean) - Set this option to false to continue downloading dataset members if one or more + Set this option to false to continue downloading data set members if one or more fail. Default value: true @@ -100,7 +100,7 @@ exports[`Download Dataset Matching should display the help 1`] = ` --preserve-original-letter-case | --po (boolean) Specifies if the automatically generated directories and files use the original - letter case + letter case. Default value: false @@ -234,8 +234,8 @@ exports[`Download Dataset Matching should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-sets-matching.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-sets-matching | dsm | data-set-matching\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all data sets that match a DSLEVEL pattern (see help below). You can\\\\n use several options to qualify which data sets will be skipped and how the\\\\n downloaded files will be structured. Data sets that are neither physical\\\\n sequential nor partitioned data sets (with members) will be excluded.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-sets-matching [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n pattern\\\\t\\\\t (string)\\\\n\\\\n The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The\\\\n following special sequences can be used in the pattern:\\\\n %: matches any single character\\\\n *: matches any number of characters within a data set name qualifier (e.g.\\\\n \\\\\\"ibmuser.j*.old\\\\\\" matches \\\\\\"ibmuser.jcl.old\\\\\\" but not \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n **: matches any number of characters within any number of data set name\\\\n qualifiers (e.g. \\\\\\"ibmuser.**.old\\\\\\" matches both \\\\\\"ibmuser.jcl.old\\\\\\" and\\\\n \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n However, the pattern cannot begin with any of these sequences.You can specify\\\\n multiple patterns separated by commas, for example\\\\n \\\\\\"ibmuser.**.cntl,ibmuser.**.jcl\\\\\\"\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --exclude-patterns | --ep (string)\\\\n\\\\n Exclude data sets that match these DSLEVEL patterns. Any data sets that match\\\\n this pattern will not be downloaded.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --extension-map | --em (string)\\\\n\\\\n Use this option to map data set names that match your pattern to the desired\\\\n extension. A comma delimited key value pairing (e.g. \\\\\\"cntl=.jcl,cpgm=.c\\\\\\" to map\\\\n the last segment of each data set (also known as the \\\\\\"low level qualifier\\\\\\" to\\\\n the desired local file extension).\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading dataset members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download all data sets beginning with \\\\\\"ibmuser\\\\\\" and ending\\\\n with \\\\\\".cntl\\\\\\" or \\\\\\".jcl\\\\\\" to the local directory \\\\\\"jcl\\\\\\" to files with the extension\\\\n \\\\\\".jcl\\\\\\":\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.**.cntl, ibmuser.**.jcl\\\\\\" --directory jcl --extension .jcl\\\\n\\\\n - Download all data sets that begin with\\\\n \\\\\\"ibmuser.public.project\\\\\\" or \\\\\\"ibmuser.project.private\\\\\\", excluding those that end\\\\n in \\\\\\"lib\\\\\\" to the local directory \\\\\\"project\\\\\\", providing a custom mapping of data\\\\n set low level qualifier to local file extension:\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.public.project.*, ibmuser.project.private.*\\\\\\" --exclude-patterns \\\\\\"ibmuser.public.**.*lib\\\\\\" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-sets-matching | dsm | data-set-matching\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all data sets that match a DSLEVEL pattern (see help below). You can\\\\n use several options to qualify which data sets will be skipped and how the\\\\n downloaded files will be structured. Data sets that are neither physical\\\\n sequential nor partitioned data sets (with members) will be excluded.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-sets-matching [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n pattern\\\\t\\\\t (string)\\\\n\\\\n The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The\\\\n following special sequences can be used in the pattern:\\\\n %: matches any single character\\\\n *: matches any number of characters within a data set name qualifier (e.g.\\\\n \\\\\\"ibmuser.j*.old\\\\\\" matches \\\\\\"ibmuser.jcl.old\\\\\\" but not \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n **: matches any number of characters within any number of data set name\\\\n qualifiers (e.g. \\\\\\"ibmuser.**.old\\\\\\" matches both \\\\\\"ibmuser.jcl.old\\\\\\" and\\\\n \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n However, the pattern cannot begin with any of these sequences.You can specify\\\\n multiple patterns separated by commas, for example\\\\n \\\\\\"ibmuser.**.cntl,ibmuser.**.jcl\\\\\\"\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --exclude-patterns | --ep (string)\\\\n\\\\n Exclude data sets that match these DSLEVEL patterns. Any data sets that match\\\\n this pattern will not be downloaded.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --extension-map | --em (string)\\\\n\\\\n Use this option to map data set names that match your pattern to the desired\\\\n extension. A comma delimited key value pairing (e.g. \\\\\\"cntl=.jcl,cpgm=.c\\\\\\" to map\\\\n the last segment of each data set (also known as the \\\\\\"low level qualifier\\\\\\" to\\\\n the desired local file extension).\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading data set members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download all data sets beginning with \\\\\\"ibmuser\\\\\\" and ending\\\\n with \\\\\\".cntl\\\\\\" or \\\\\\".jcl\\\\\\" to the local directory \\\\\\"jcl\\\\\\" to files with the extension\\\\n \\\\\\".jcl\\\\\\":\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.**.cntl, ibmuser.**.jcl\\\\\\" --directory jcl --extension .jcl\\\\n\\\\n - Download all data sets that begin with\\\\n \\\\\\"ibmuser.public.project\\\\\\" or \\\\\\"ibmuser.project.private\\\\\\", excluding those that end\\\\n in \\\\\\"lib\\\\\\" to the local directory \\\\\\"project\\\\\\", providing a custom mapping of data\\\\n set low level qualifier to local file extension:\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.public.project.*, ibmuser.project.private.*\\\\\\" --exclude-patterns \\\\\\"ibmuser.public.**.*lib\\\\\\" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-sets-matching | dsm | data-set-matching\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all data sets that match a DSLEVEL pattern (see help below). You can\\\\n use several options to qualify which data sets will be skipped and how the\\\\n downloaded files will be structured. Data sets that are neither physical\\\\n sequential nor partitioned data sets (with members) will be excluded.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-sets-matching [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n pattern\\\\t\\\\t (string)\\\\n\\\\n The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The\\\\n following special sequences can be used in the pattern:\\\\n %: matches any single character\\\\n *: matches any number of characters within a data set name qualifier (e.g.\\\\n \\\\\\"ibmuser.j*.old\\\\\\" matches \\\\\\"ibmuser.jcl.old\\\\\\" but not \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n **: matches any number of characters within any number of data set name\\\\n qualifiers (e.g. \\\\\\"ibmuser.**.old\\\\\\" matches both \\\\\\"ibmuser.jcl.old\\\\\\" and\\\\n \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n However, the pattern cannot begin with any of these sequences.You can specify\\\\n multiple patterns separated by commas, for example\\\\n \\\\\\"ibmuser.**.cntl,ibmuser.**.jcl\\\\\\"\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --exclude-patterns | --ep (string)\\\\n\\\\n Exclude data sets that match these DSLEVEL patterns. Any data sets that match\\\\n this pattern will not be downloaded.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --extension-map | --em (string)\\\\n\\\\n Use this option to map data set names that match your pattern to the desired\\\\n extension. A comma delimited key value pairing (e.g. \\\\\\"cntl=.jcl,cpgm=.c\\\\\\" to map\\\\n the last segment of each data set (also known as the \\\\\\"low level qualifier\\\\\\" to\\\\n the desired local file extension).\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading dataset members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download all data sets beginning with \\\\\\"ibmuser\\\\\\" and ending\\\\n with \\\\\\".cntl\\\\\\" or \\\\\\".jcl\\\\\\" to the local directory \\\\\\"jcl\\\\\\" to files with the extension\\\\n \\\\\\".jcl\\\\\\":\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.**.cntl, ibmuser.**.jcl\\\\\\" --directory jcl --extension .jcl\\\\n\\\\n - Download all data sets that begin with\\\\n \\\\\\"ibmuser.public.project\\\\\\" or \\\\\\"ibmuser.project.private\\\\\\", excluding those that end\\\\n in \\\\\\"lib\\\\\\" to the local directory \\\\\\"project\\\\\\", providing a custom mapping of data\\\\n set low level qualifier to local file extension:\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.public.project.*, ibmuser.project.private.*\\\\\\" --exclude-patterns \\\\\\"ibmuser.public.**.*lib\\\\\\" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-sets-matching | dsm | data-set-matching\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download all data sets that match a DSLEVEL pattern (see help below). You can\\\\n use several options to qualify which data sets will be skipped and how the\\\\n downloaded files will be structured. Data sets that are neither physical\\\\n sequential nor partitioned data sets (with members) will be excluded.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download data-sets-matching [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n pattern\\\\t\\\\t (string)\\\\n\\\\n The pattern or patterns to match data sets against. Also known as 'DSLEVEL'. The\\\\n following special sequences can be used in the pattern:\\\\n %: matches any single character\\\\n *: matches any number of characters within a data set name qualifier (e.g.\\\\n \\\\\\"ibmuser.j*.old\\\\\\" matches \\\\\\"ibmuser.jcl.old\\\\\\" but not \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n **: matches any number of characters within any number of data set name\\\\n qualifiers (e.g. \\\\\\"ibmuser.**.old\\\\\\" matches both \\\\\\"ibmuser.jcl.old\\\\\\" and\\\\n \\\\\\"ibmuser.jcl.very.old\\\\\\")\\\\n However, the pattern cannot begin with any of these sequences.You can specify\\\\n multiple patterns separated by commas, for example\\\\n \\\\\\"ibmuser.**.cntl,ibmuser.**.jcl\\\\\\"\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the members. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n creates a folder structure based on the data set qualifiers. For example, the\\\\n data set ibmuser.new.cntl's members are downloaded to ibmuser/new/cntl).\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --exclude-patterns | --ep (string)\\\\n\\\\n Exclude data sets that match these DSLEVEL patterns. Any data sets that match\\\\n this pattern will not be downloaded.\\\\n\\\\n --extension | -e (string)\\\\n\\\\n Save the local files with a specified file extension. For example, .txt. Or \\\\\\"\\\\\\"\\\\n for no extension. When no extension is specified, .txt is used as the default\\\\n file extension.\\\\n\\\\n --extension-map | --em (string)\\\\n\\\\n Use this option to map data set names that match your pattern to the desired\\\\n extension. A comma delimited key value pairing (e.g. \\\\\\"cntl=.jcl,cpgm=.c\\\\\\" to map\\\\n the last segment of each data set (also known as the \\\\\\"low level qualifier\\\\\\" to\\\\n the desired local file extension).\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading data set members if one or more\\\\n fail.\\\\n\\\\n Default value: true\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n members. Increasing the value results in faster downloads. However, increasing\\\\n the value increases resource consumption on z/OS and can be prone to errors\\\\n caused by making too many concurrent requests. If the download process\\\\n encounters an error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --preserve-original-letter-case | --po (boolean)\\\\n\\\\n Specifies if the automatically generated directories and files use the original\\\\n letter case.\\\\n\\\\n Default value: false\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Download the file content in record mode, which means that no data conversion is\\\\n performed and the record length is prepended to the data. The data transfer\\\\n process returns each line as-is, without translation. No delimiters are added\\\\n between records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download all data sets beginning with \\\\\\"ibmuser\\\\\\" and ending\\\\n with \\\\\\".cntl\\\\\\" or \\\\\\".jcl\\\\\\" to the local directory \\\\\\"jcl\\\\\\" to files with the extension\\\\n \\\\\\".jcl\\\\\\":\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.**.cntl, ibmuser.**.jcl\\\\\\" --directory jcl --extension .jcl\\\\n\\\\n - Download all data sets that begin with\\\\n \\\\\\"ibmuser.public.project\\\\\\" or \\\\\\"ibmuser.project.private\\\\\\", excluding those that end\\\\n in \\\\\\"lib\\\\\\" to the local directory \\\\\\"project\\\\\\", providing a custom mapping of data\\\\n set low level qualifier to local file extension:\\\\n\\\\n $ zowe zos-files download data-sets-matching \\\\\\"ibmuser.public.project.*, ibmuser.project.private.*\\\\\\" --exclude-patterns \\\\\\"ibmuser.public.**.*lib\\\\\\" --directory project --extension-map cpgm=c,asmpgm=asm,java=java,chdr=c,jcl=jcl,cntl=jcl\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/download/uss/__snapshots__/cli.files.download.uss.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/download/uss/__snapshots__/cli.files.download.uss.integration.test.ts.snap index 80245f68d0..31c18dade7 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/download/uss/__snapshots__/cli.files.download.uss.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/download/uss/__snapshots__/cli.files.download.uss.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Download USS File should display the help 1`] = ` DESCRIPTION ----------- - Download content from a USS file to a local file on your PC + Download content from a USS file to a local file on your PC. USAGE ----- @@ -158,8 +158,8 @@ exports[`Download USS File should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: uss-file.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS file to a local file on your PC\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" to\\\\n ./my_text.txt:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" -f ./my_text.txt\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" to\\\\n \\\\\\"java/MyJava.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" -b -f \\\\\\"java/MyJava.class\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS file to a local file on your PC.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" to\\\\n ./my_text.txt:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" -f ./my_text.txt\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" to\\\\n \\\\\\"java/MyJava.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" -b -f \\\\\\"java/MyJava.class\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS file to a local file on your PC\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" to\\\\n ./my_text.txt:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" -f ./my_text.txt\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" to\\\\n \\\\\\"java/MyJava.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" -b -f \\\\\\"java/MyJava.class\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-file | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS file to a local file on your PC.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-file [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --file | -f (string)\\\\n\\\\n The path to the local file where you want to download the content. When you omit\\\\n the option, the command generates a file name automatically for you.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" to\\\\n ./my_text.txt:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" -f ./my_text.txt\\\\n\\\\n - Download the file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" to\\\\n \\\\\\"java/MyJava.class\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-file \\\\\\"/a/ibmuser/MyJava.class\\\\\\" -b -f \\\\\\"java/MyJava.class\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/download/ussdir/__snapshots__/cli.files.download.ussdir.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/download/ussdir/__snapshots__/cli.files.download.ussdir.integration.test.ts.snap index dbe368a994..95648592c7 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/download/ussdir/__snapshots__/cli.files.download.ussdir.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/download/ussdir/__snapshots__/cli.files.download.ussdir.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Download USS Directory should display the help 1`] = ` DESCRIPTION ----------- - Download content from a USS directory to a local directory on your PC + Download content from a USS directory to a local directory on your PC. USAGE ----- @@ -30,7 +30,7 @@ exports[`Download USS Directory should display the help 1`] = ` --attributes | --attrs (local file path) - Path of an attributes file to control how files are downloaded + Path of an attributes file to control how files are downloaded. --binary | -b (boolean) @@ -70,7 +70,7 @@ exports[`Download USS Directory should display the help 1`] = ` --include-hidden | --ih (boolean) - Include hidden files and folders that have names beginning with a dot + Include hidden files and folders that have names beginning with a dot. --max-concurrent-requests | --mcr (number) @@ -102,7 +102,7 @@ exports[`Download USS Directory should display the help 1`] = ` --overwrite | --ow (boolean) - Overwrite files that already exist in your local environment + Overwrite files that already exist in your local environment. --owner (string) @@ -247,8 +247,8 @@ exports[`Download USS Directory should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: uss-directory.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-directory | uss-dir\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS directory to a local directory on your PC\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-directory [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussDirName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | --attrs (local file path)\\\\n\\\\n Path of an attributes file to control how files are downloaded\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --depth (number)\\\\n\\\\n Filters content in USS based on the number of directories to traverse down.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the files. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n downloads the files to the current directory.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading USS files if one or more fail.\\\\n\\\\n Default value: true\\\\n\\\\n --filesys (boolean)\\\\n\\\\n Filters content in USS based on the filesystem the data is on. true - all\\\\n filesystems, false - same filesystem as search directory.\\\\n\\\\n --group (string)\\\\n\\\\n Filters content in USS based on the owning group name or ID.\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n files. Increasing the value results in faster downloads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the download process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all files at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --mtime (string)\\\\n\\\\n Filters content in USS based on the last modification time. N - specify an exact\\\\n number of days, +N - older than N days, -N - newer than N days\\\\n\\\\n --name (string)\\\\n\\\\n Filters files in USS based on the name of the file or directory.\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Overwrite files that already exist in your local environment\\\\n\\\\n --owner (string)\\\\n\\\\n Filters content in USS based on the owning user name or ID.\\\\n\\\\n --perm (string)\\\\n\\\\n Filters content in USS based on the octal permissions string.\\\\n\\\\n --size (string)\\\\n\\\\n Filters content in USS based on the size. Default units are bytes. Add a suffix\\\\n of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact\\\\n file size, +N - larger than N size, -N - smaller than N size\\\\n\\\\n --symlinks (boolean)\\\\n\\\\n Filters content in USS based on whether or not to follow symbolic links. true -\\\\n report symlinks, false - follow symlinks\\\\n\\\\n --type (string)\\\\n\\\\n Filters content in USS based on the type of content. f - regular file, d -\\\\n directory, l - symbolic link, p - FIFO named pipe, s - socket\\\\n\\\\n Allowed values: f, d, l, p, s\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --binary\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./localDir\\\\\\":\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --directory localDir\\\\n\\\\n - Download files from the directory \\\\\\"/a/ibmuser\\\\\\" that match\\\\n the name \\\\\\"*.log\\\\\\" and were modified within the last day:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --name \\\\\\"*.log\\\\\\" --mtime -1\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-directory | uss-dir\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS directory to a local directory on your PC.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-directory [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussDirName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | --attrs (local file path)\\\\n\\\\n Path of an attributes file to control how files are downloaded.\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --depth (number)\\\\n\\\\n Filters content in USS based on the number of directories to traverse down.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the files. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n downloads the files to the current directory.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading USS files if one or more fail.\\\\n\\\\n Default value: true\\\\n\\\\n --filesys (boolean)\\\\n\\\\n Filters content in USS based on the filesystem the data is on. true - all\\\\n filesystems, false - same filesystem as search directory.\\\\n\\\\n --group (string)\\\\n\\\\n Filters content in USS based on the owning group name or ID.\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n files. Increasing the value results in faster downloads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the download process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all files at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --mtime (string)\\\\n\\\\n Filters content in USS based on the last modification time. N - specify an exact\\\\n number of days, +N - older than N days, -N - newer than N days\\\\n\\\\n --name (string)\\\\n\\\\n Filters files in USS based on the name of the file or directory.\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Overwrite files that already exist in your local environment.\\\\n\\\\n --owner (string)\\\\n\\\\n Filters content in USS based on the owning user name or ID.\\\\n\\\\n --perm (string)\\\\n\\\\n Filters content in USS based on the octal permissions string.\\\\n\\\\n --size (string)\\\\n\\\\n Filters content in USS based on the size. Default units are bytes. Add a suffix\\\\n of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact\\\\n file size, +N - larger than N size, -N - smaller than N size\\\\n\\\\n --symlinks (boolean)\\\\n\\\\n Filters content in USS based on whether or not to follow symbolic links. true -\\\\n report symlinks, false - follow symlinks\\\\n\\\\n --type (string)\\\\n\\\\n Filters content in USS based on the type of content. f - regular file, d -\\\\n directory, l - symbolic link, p - FIFO named pipe, s - socket\\\\n\\\\n Allowed values: f, d, l, p, s\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --binary\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./localDir\\\\\\":\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --directory localDir\\\\n\\\\n - Download files from the directory \\\\\\"/a/ibmuser\\\\\\" that match\\\\n the name \\\\\\"*.log\\\\\\" and were modified within the last day:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --name \\\\\\"*.log\\\\\\" --mtime -1\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-directory | uss-dir\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS directory to a local directory on your PC\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-directory [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussDirName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | --attrs (local file path)\\\\n\\\\n Path of an attributes file to control how files are downloaded\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --depth (number)\\\\n\\\\n Filters content in USS based on the number of directories to traverse down.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the files. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n downloads the files to the current directory.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading USS files if one or more fail.\\\\n\\\\n Default value: true\\\\n\\\\n --filesys (boolean)\\\\n\\\\n Filters content in USS based on the filesystem the data is on. true - all\\\\n filesystems, false - same filesystem as search directory.\\\\n\\\\n --group (string)\\\\n\\\\n Filters content in USS based on the owning group name or ID.\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n files. Increasing the value results in faster downloads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the download process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all files at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --mtime (string)\\\\n\\\\n Filters content in USS based on the last modification time. N - specify an exact\\\\n number of days, +N - older than N days, -N - newer than N days\\\\n\\\\n --name (string)\\\\n\\\\n Filters files in USS based on the name of the file or directory.\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Overwrite files that already exist in your local environment\\\\n\\\\n --owner (string)\\\\n\\\\n Filters content in USS based on the owning user name or ID.\\\\n\\\\n --perm (string)\\\\n\\\\n Filters content in USS based on the octal permissions string.\\\\n\\\\n --size (string)\\\\n\\\\n Filters content in USS based on the size. Default units are bytes. Add a suffix\\\\n of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact\\\\n file size, +N - larger than N size, -N - smaller than N size\\\\n\\\\n --symlinks (boolean)\\\\n\\\\n Filters content in USS based on whether or not to follow symbolic links. true -\\\\n report symlinks, false - follow symlinks\\\\n\\\\n --type (string)\\\\n\\\\n Filters content in USS based on the type of content. f - regular file, d -\\\\n directory, l - symbolic link, p - FIFO named pipe, s - socket\\\\n\\\\n Allowed values: f, d, l, p, s\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --binary\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./localDir\\\\\\":\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --directory localDir\\\\n\\\\n - Download files from the directory \\\\\\"/a/ibmuser\\\\\\" that match\\\\n the name \\\\\\"*.log\\\\\\" and were modified within the last day:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --name \\\\\\"*.log\\\\\\" --mtime -1\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-directory | uss-dir\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Download content from a USS directory to a local directory on your PC.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files download uss-directory [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n ussDirName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory you want to download\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | --attrs (local file path)\\\\n\\\\n Path of an attributes file to control how files are downloaded.\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Download the file content in binary mode, which means that no data conversion is\\\\n performed. The data transfer process returns each line as-is, without\\\\n translation. No delimiters are added between records.\\\\n\\\\n --depth (number)\\\\n\\\\n Filters content in USS based on the number of directories to traverse down.\\\\n\\\\n --directory | -d (string)\\\\n\\\\n The directory to where you want to save the files. The command creates the\\\\n directory for you when it does not already exist. By default, the command\\\\n downloads the files to the current directory.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Download the file content with encoding mode, which means that data conversion\\\\n is performed using the file encoding specified.\\\\n\\\\n --fail-fast | --ff (boolean)\\\\n\\\\n Set this option to false to continue downloading USS files if one or more fail.\\\\n\\\\n Default value: true\\\\n\\\\n --filesys (boolean)\\\\n\\\\n Filters content in USS based on the filesystem the data is on. true - all\\\\n filesystems, false - same filesystem as search directory.\\\\n\\\\n --group (string)\\\\n\\\\n Filters content in USS based on the owning group name or ID.\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to download\\\\n files. Increasing the value results in faster downloads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the download process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to download all files at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --mtime (string)\\\\n\\\\n Filters content in USS based on the last modification time. N - specify an exact\\\\n number of days, +N - older than N days, -N - newer than N days\\\\n\\\\n --name (string)\\\\n\\\\n Filters files in USS based on the name of the file or directory.\\\\n\\\\n --overwrite | --ow (boolean)\\\\n\\\\n Overwrite files that already exist in your local environment.\\\\n\\\\n --owner (string)\\\\n\\\\n Filters content in USS based on the owning user name or ID.\\\\n\\\\n --perm (string)\\\\n\\\\n Filters content in USS based on the octal permissions string.\\\\n\\\\n --size (string)\\\\n\\\\n Filters content in USS based on the size. Default units are bytes. Add a suffix\\\\n of K for kilobytes, M for megabytes, or G for gigabytes. N - specify an exact\\\\n file size, +N - larger than N size, -N - smaller than N size\\\\n\\\\n --symlinks (boolean)\\\\n\\\\n Filters content in USS based on whether or not to follow symbolic links. true -\\\\n report symlinks, false - follow symlinks\\\\n\\\\n --type (string)\\\\n\\\\n Filters content in USS based on the type of content. f - regular file, d -\\\\n directory, l - symbolic link, p - FIFO named pipe, s - socket\\\\n\\\\n Allowed values: f, d, l, p, s\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./\\\\\\" in binary mode:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --binary\\\\n\\\\n - Download the directory \\\\\\"/a/ibmuser\\\\\\" to \\\\\\"./localDir\\\\\\":\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --directory localDir\\\\n\\\\n - Download files from the directory \\\\\\"/a/ibmuser\\\\\\" that match\\\\n the name \\\\\\"*.log\\\\\\" and were modified within the last day:\\\\n\\\\n $ zowe zos-files download uss-directory /a/ibmuser --name \\\\\\"*.log\\\\\\" --mtime -1\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/list/ds/__snapshots__/cli.files.list.ds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/list/ds/__snapshots__/cli.files.list.ds.integration.test.ts.snap index dbf752a489..dc36ec64e2 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/list/ds/__snapshots__/cli.files.list.ds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/list/ds/__snapshots__/cli.files.list.ds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`List data set should display the help 1`] = ` DESCRIPTION ----------- - List data sets that match a pattern in the data set name + List data sets that match a pattern in the data set name. USAGE ----- @@ -176,8 +176,8 @@ exports[`List data set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List data sets that match a pattern in the data set name\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name or pattern of the data set that you want to list\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Display more information about each member. Data sets with an undefined record\\\\n format display information related to executable modules. Variable and fixed\\\\n block data sets display information about when the members were created and\\\\n modified.\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --start | -s (string)\\\\n\\\\n An optional search parameter that specifies the first data set name to return in\\\\n the response document.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the data set \\\\\\"ibmuser.asm\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.asm\\\\\\"\\\\n\\\\n - Show attributes of the data set \\\\\\"ibmuser.cntl\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" -a\\\\n\\\\n - Show all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\"\\\\n\\\\n - Show attributes of all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\" -a\\\\n\\\\n - Show the first 5 data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" --max 5\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List data sets that match a pattern in the data set name.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name or pattern of the data set that you want to list\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Display more information about each member. Data sets with an undefined record\\\\n format display information related to executable modules. Variable and fixed\\\\n block data sets display information about when the members were created and\\\\n modified.\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --start | -s (string)\\\\n\\\\n An optional search parameter that specifies the first data set name to return in\\\\n the response document.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the data set \\\\\\"ibmuser.asm\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.asm\\\\\\"\\\\n\\\\n - Show attributes of the data set \\\\\\"ibmuser.cntl\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" -a\\\\n\\\\n - Show all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\"\\\\n\\\\n - Show attributes of all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\" -a\\\\n\\\\n - Show the first 5 data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" --max 5\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List data sets that match a pattern in the data set name\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name or pattern of the data set that you want to list\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Display more information about each member. Data sets with an undefined record\\\\n format display information related to executable modules. Variable and fixed\\\\n block data sets display information about when the members were created and\\\\n modified.\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --start | -s (string)\\\\n\\\\n An optional search parameter that specifies the first data set name to return in\\\\n the response document.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the data set \\\\\\"ibmuser.asm\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.asm\\\\\\"\\\\n\\\\n - Show attributes of the data set \\\\\\"ibmuser.cntl\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" -a\\\\n\\\\n - Show all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\"\\\\n\\\\n - Show attributes of all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\" -a\\\\n\\\\n - Show the first 5 data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" --max 5\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n data-set | ds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List data sets that match a pattern in the data set name.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name or pattern of the data set that you want to list\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --attributes | -a (boolean)\\\\n\\\\n Display more information about each member. Data sets with an undefined record\\\\n format display information related to executable modules. Variable and fixed\\\\n block data sets display information about when the members were created and\\\\n modified.\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --start | -s (string)\\\\n\\\\n An optional search parameter that specifies the first data set name to return in\\\\n the response document.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the data set \\\\\\"ibmuser.asm\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.asm\\\\\\"\\\\n\\\\n - Show attributes of the data set \\\\\\"ibmuser.cntl\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" -a\\\\n\\\\n - Show all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\"\\\\n\\\\n - Show attributes of all data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.*\\\\\\" -a\\\\n\\\\n - Show the first 5 data sets of the user \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-files list data-set \\\\\\"ibmuser.cntl\\\\\\" --max 5\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/list/uss/__snapshots__/cli.files.list.uss.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/list/uss/__snapshots__/cli.files.list.uss.integration.test.ts.snap index 2fe3d8a801..5813ff7de4 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/list/uss/__snapshots__/cli.files.list.uss.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/list/uss/__snapshots__/cli.files.list.uss.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`List USS file should display the help 1`] = ` DESCRIPTION ----------- - List USS files and directories in a UNIX file path + List USS files and directories in a UNIX file path. USAGE ----- @@ -188,8 +188,8 @@ exports[`List USS file should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: uss-files.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-files | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List USS files and directories in a UNIX file path\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list uss-files [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n path\\\\t\\\\t (string)\\\\n\\\\n The directory containing the files and directories to be listed\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the files and directories in path '/u/ibmuser':\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\"\\\\n\\\\n - Show the files and directories in path '/u/ibmuser\\\\n displaying only the file or directory name:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rff name\\\\n\\\\n - Show the files and directories in path '/u/ibmuser'\\\\n displaying the headers associated with the file detail:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rfh\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-files | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List USS files and directories in a UNIX file path.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list uss-files [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n path\\\\t\\\\t (string)\\\\n\\\\n The directory containing the files and directories to be listed\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the files and directories in path '/u/ibmuser':\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\"\\\\n\\\\n - Show the files and directories in path '/u/ibmuser\\\\n displaying only the file or directory name:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rff name\\\\n\\\\n - Show the files and directories in path '/u/ibmuser'\\\\n displaying the headers associated with the file detail:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rfh\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-files | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List USS files and directories in a UNIX file path\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list uss-files [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n path\\\\t\\\\t (string)\\\\n\\\\n The directory containing the files and directories to be listed\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the files and directories in path '/u/ibmuser':\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\"\\\\n\\\\n - Show the files and directories in path '/u/ibmuser\\\\n displaying only the file or directory name:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rff name\\\\n\\\\n - Show the files and directories in path '/u/ibmuser'\\\\n displaying the headers associated with the file detail:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rfh\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n uss-files | uf | uss\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n List USS files and directories in a UNIX file path.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files list uss-files [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n path\\\\t\\\\t (string)\\\\n\\\\n The directory containing the files and directories to be listed\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --max-length | --max (number)\\\\n\\\\n The option --max-length specifies the maximum number of items to return. Skip\\\\n this parameter to return all items. If you specify an incorrect value, the\\\\n parameter returns up to 1000 items.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n RESPONSE FORMAT OPTIONS\\\\n -----------------------\\\\n\\\\n --response-format-filter | --rff (array)\\\\n\\\\n Filter (include) fields in the response. Accepts an array of field/property\\\\n names to include in the output response. You can filter JSON objects properties\\\\n OR table columns/fields. In addition, you can use this option in conjunction\\\\n with '--response-format-type' to reduce the output of a command to a single\\\\n field/property or a list of a single field/property.\\\\n\\\\n --response-format-type | --rft (string)\\\\n\\\\n The command response output format type. Must be one of the following:\\\\n\\\\n table: Formats output data as a table. Use this option when the output data is\\\\n an array of homogeneous JSON objects. Each property of the object will become a\\\\n column in the table.\\\\n\\\\n list: Formats output data as a list of strings. Can be used on any data type\\\\n (JSON objects/arrays) are stringified and a new line is added after each entry\\\\n in an array.\\\\n\\\\n object: Formats output data as a list of prettified objects (or single object).\\\\n Can be used in place of \\\\\\"table\\\\\\" to change from tabular output to a list of\\\\n prettified objects.\\\\n\\\\n string: Formats output data as a string. JSON objects/arrays are stringified.\\\\n\\\\n Allowed values: table, list, object, string\\\\n\\\\n --response-format-header | --rfh (boolean)\\\\n\\\\n If \\\\\\"--response-format-type table\\\\\\" is specified, include the column headers in\\\\n the output.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Show the files and directories in path '/u/ibmuser':\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\"\\\\n\\\\n - Show the files and directories in path '/u/ibmuser\\\\n displaying only the file or directory name:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rff name\\\\n\\\\n - Show the files and directories in path '/u/ibmuser'\\\\n displaying the headers associated with the file detail:\\\\n\\\\n $ zowe zos-files list uss-files \\\\\\"/u/ibmuser\\\\\\" --rfh\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/upload/dtp/__snapshots__/cli.files.upload.dtp.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/upload/dtp/__snapshots__/cli.files.upload.dtp.integration.test.ts.snap index 84254be4db..9336f4e8c8 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/upload/dtp/__snapshots__/cli.files.upload.dtp.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/upload/dtp/__snapshots__/cli.files.upload.dtp.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Upload directory to PDS should display the help 1`] = ` DESCRIPTION ----------- - Upload files from a local directory to a partitioned data set (PDS) + Upload files from a local directory to a partitioned data set (PDS). USAGE ----- @@ -178,8 +178,8 @@ exports[`Upload directory to PDS should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: dir-to-pds.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-pds | dtp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload files from a local directory to a partitioned data set (PDS)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-pds [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputdir\\\\t\\\\t (string)\\\\n\\\\n The path for a local directory that you want to upload to a PDS\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the partitioned data set to which you want to upload the files\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a PDS named\\\\n \\\\\\"ibmuser.src\\\\\\":\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\"\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a migrated PDS named\\\\n \\\\\\"ibmuser.src\\\\\\" and wait for it to be recalled:\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\" --mr wait\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-pds | dtp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload files from a local directory to a partitioned data set (PDS).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-pds [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputdir\\\\t\\\\t (string)\\\\n\\\\n The path for a local directory that you want to upload to a PDS\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the partitioned data set to which you want to upload the files\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a PDS named\\\\n \\\\\\"ibmuser.src\\\\\\":\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\"\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a migrated PDS named\\\\n \\\\\\"ibmuser.src\\\\\\" and wait for it to be recalled:\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\" --mr wait\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-pds | dtp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload files from a local directory to a partitioned data set (PDS)\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-pds [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputdir\\\\t\\\\t (string)\\\\n\\\\n The path for a local directory that you want to upload to a PDS\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the partitioned data set to which you want to upload the files\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a PDS named\\\\n \\\\\\"ibmuser.src\\\\\\":\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\"\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a migrated PDS named\\\\n \\\\\\"ibmuser.src\\\\\\" and wait for it to be recalled:\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\" --mr wait\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-pds | dtp\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload files from a local directory to a partitioned data set (PDS).\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-pds [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputdir\\\\t\\\\t (string)\\\\n\\\\n The path for a local directory that you want to upload to a PDS\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the partitioned data set to which you want to upload the files\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a PDS named\\\\n \\\\\\"ibmuser.src\\\\\\":\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\"\\\\n\\\\n - Upload a directory named \\\\\\"src\\\\\\" to a migrated PDS named\\\\n \\\\\\"ibmuser.src\\\\\\" and wait for it to be recalled:\\\\n\\\\n $ zowe zos-files upload dir-to-pds \\\\\\"src\\\\\\" \\\\\\"ibmuser.src\\\\\\" --mr wait\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/upload/dtu/__snapshots__/cli.files.upload.dtu.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/upload/dtu/__snapshots__/cli.files.upload.dtu.integration.test.ts.snap index 75a3df29f6..1d9522bdb2 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/upload/dtu/__snapshots__/cli.files.upload.dtu.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/upload/dtu/__snapshots__/cli.files.upload.dtu.integration.test.ts.snap @@ -95,7 +95,7 @@ exports[`Upload local dir to uss dir should display the help 1`] = ` --attributes | --attrs (string) - Path of an attributes file to control how files are uploaded + Path of an attributes file to control how files are uploaded. --max-concurrent-requests | --mcr (number) @@ -112,7 +112,7 @@ exports[`Upload local dir to uss dir should display the help 1`] = ` --include-hidden | --ih (boolean) - Include hidden files and folders that have names beginning with a dot + Include hidden files and folders that have names beginning with a dot. --response-timeout | --rto (number) @@ -246,8 +246,8 @@ exports[`Upload local dir to uss dir should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: dir-to-uss.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-uss | dtu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload a local directory to a USS directory.\\\\n\\\\n An optional .zosattributes file in the source directory can be used to control\\\\n file conversion and tagging.\\\\n\\\\n An example .zosattributes file:\\\\n # pattern local-encoding remote-encoding\\\\n # Don't upload the node_modules directory\\\\n node_modules -\\\\n # Don't upload files that start with periods\\\\n .* -\\\\n # Upload jpg images in binary\\\\n *.jpg binary binary\\\\n # Convert CICS Node.js profiles to EBCDIC\\\\n *.profile ISO8859-1 EBCDIC\\\\n\\\\n Lines starting with the ‘#’ character are comments. Each line can specify up to\\\\n three positional attributes:\\\\n A pattern to match a set of files. Pattern-matching syntax follows\\\\n the same rules as those that apply in .gitignore files (note that negated\\\\n patterns that begin with ‘!’ are not supported). See\\\\n https://git-scm.com/docs/gitignore#_pattern_format.\\\\n A local-encoding to identify a file’s encoding on the local\\\\n workstation. If '-' is specified for local-encoding,files that match the pattern\\\\n are not transferred.\\\\n A remote-encoding to specify the file’s desired character set on USS.\\\\n This attribute must either match the local encoding or be set to EBCDIC. If set\\\\n to EBCDIC, files are transferred in text mode and converted, otherwise they are\\\\n transferred in binary mode. Remote files are tagged either with the remote\\\\n encoding or as binary.\\\\n\\\\n A .zosattributes file can either be placed in the top-level directory you want\\\\n to upload, or its location can be specified by using the --attributes parameter.\\\\n .zosattributes files that are placed in nested directories are ignored.\\\\n\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputDir\\\\t\\\\t (string)\\\\n\\\\n The local directory path that you want to upload to a USS directory\\\\n\\\\n USSDir\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory to which you want to upload the local directory\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Upload all directories recursively.\\\\n\\\\n --binary-files | --bf (string)\\\\n\\\\n Comma separated list of file names to be uploaded in binary mode. Use this\\\\n option when you upload a directory in default ASCII mode, but you want to\\\\n specify certain files to be uploaded in binary mode. All files matching\\\\n specified file names will be uploaded in binary mode. If a .zosattributes file\\\\n (or equivalent file specified via --attributes) is present, --binary-files will\\\\n be ignored.\\\\n\\\\n --ascii-files | --af (string)\\\\n\\\\n Comma separated list of file names to be uploaded in ASCII mode. Use this option\\\\n when you upload a directory with --binary/-b flag, but you want to specify\\\\n certain files to be uploaded in ASCII mode. All files matching specified file\\\\n names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent\\\\n file specified via --attributes) is present, --ascii-files will be ignored.\\\\n\\\\n --attributes | --attrs (string)\\\\n\\\\n Path of an attributes file to control how files are uploaded\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to upload\\\\n files. Increasing the value results in faster uploads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the upload process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to upload all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory and all its\\\\n sub-directories, to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in default ASCII mode, while specifying a list\\\\n of file names (without path) to be uploaded in binary mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary-files \\\\\\"myFile1.exe,myFile2.exe,myFile3.exe\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in binary mode, while specifying a list of\\\\n file names (without path) to be uploaded in ASCII mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary --ascii-files \\\\\\"myFile1.txt,myFile2.txt,myFile3.txt\\\\\\"\\\\n\\\\n - Recursively upload all files from the \\\\\\"local_dir\\\\\\" directory\\\\n to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory, specifying files to ignore and file\\\\n encodings in the local file my_global_attributes:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive --attributes my_global_attributes\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-uss | dtu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload a local directory to a USS directory.\\\\n\\\\n An optional .zosattributes file in the source directory can be used to control\\\\n file conversion and tagging.\\\\n\\\\n An example .zosattributes file:\\\\n # pattern local-encoding remote-encoding\\\\n # Don't upload the node_modules directory\\\\n node_modules -\\\\n # Don't upload files that start with periods\\\\n .* -\\\\n # Upload jpg images in binary\\\\n *.jpg binary binary\\\\n # Convert CICS Node.js profiles to EBCDIC\\\\n *.profile ISO8859-1 EBCDIC\\\\n\\\\n Lines starting with the ‘#’ character are comments. Each line can specify up to\\\\n three positional attributes:\\\\n A pattern to match a set of files. Pattern-matching syntax follows\\\\n the same rules as those that apply in .gitignore files (note that negated\\\\n patterns that begin with ‘!’ are not supported). See\\\\n https://git-scm.com/docs/gitignore#_pattern_format.\\\\n A local-encoding to identify a file’s encoding on the local\\\\n workstation. If '-' is specified for local-encoding,files that match the pattern\\\\n are not transferred.\\\\n A remote-encoding to specify the file’s desired character set on USS.\\\\n This attribute must either match the local encoding or be set to EBCDIC. If set\\\\n to EBCDIC, files are transferred in text mode and converted, otherwise they are\\\\n transferred in binary mode. Remote files are tagged either with the remote\\\\n encoding or as binary.\\\\n\\\\n A .zosattributes file can either be placed in the top-level directory you want\\\\n to upload, or its location can be specified by using the --attributes parameter.\\\\n .zosattributes files that are placed in nested directories are ignored.\\\\n\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputDir\\\\t\\\\t (string)\\\\n\\\\n The local directory path that you want to upload to a USS directory\\\\n\\\\n USSDir\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory to which you want to upload the local directory\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Upload all directories recursively.\\\\n\\\\n --binary-files | --bf (string)\\\\n\\\\n Comma separated list of file names to be uploaded in binary mode. Use this\\\\n option when you upload a directory in default ASCII mode, but you want to\\\\n specify certain files to be uploaded in binary mode. All files matching\\\\n specified file names will be uploaded in binary mode. If a .zosattributes file\\\\n (or equivalent file specified via --attributes) is present, --binary-files will\\\\n be ignored.\\\\n\\\\n --ascii-files | --af (string)\\\\n\\\\n Comma separated list of file names to be uploaded in ASCII mode. Use this option\\\\n when you upload a directory with --binary/-b flag, but you want to specify\\\\n certain files to be uploaded in ASCII mode. All files matching specified file\\\\n names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent\\\\n file specified via --attributes) is present, --ascii-files will be ignored.\\\\n\\\\n --attributes | --attrs (string)\\\\n\\\\n Path of an attributes file to control how files are uploaded.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to upload\\\\n files. Increasing the value results in faster uploads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the upload process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to upload all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory and all its\\\\n sub-directories, to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in default ASCII mode, while specifying a list\\\\n of file names (without path) to be uploaded in binary mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary-files \\\\\\"myFile1.exe,myFile2.exe,myFile3.exe\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in binary mode, while specifying a list of\\\\n file names (without path) to be uploaded in ASCII mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary --ascii-files \\\\\\"myFile1.txt,myFile2.txt,myFile3.txt\\\\\\"\\\\n\\\\n - Recursively upload all files from the \\\\\\"local_dir\\\\\\" directory\\\\n to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory, specifying files to ignore and file\\\\n encodings in the local file my_global_attributes:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive --attributes my_global_attributes\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-uss | dtu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload a local directory to a USS directory.\\\\n\\\\n An optional .zosattributes file in the source directory can be used to control\\\\n file conversion and tagging.\\\\n\\\\n An example .zosattributes file:\\\\n # pattern local-encoding remote-encoding\\\\n # Don't upload the node_modules directory\\\\n node_modules -\\\\n # Don't upload files that start with periods\\\\n .* -\\\\n # Upload jpg images in binary\\\\n *.jpg binary binary\\\\n # Convert CICS Node.js profiles to EBCDIC\\\\n *.profile ISO8859-1 EBCDIC\\\\n\\\\n Lines starting with the ‘#’ character are comments. Each line can specify up to\\\\n three positional attributes:\\\\n A pattern to match a set of files. Pattern-matching syntax follows\\\\n the same rules as those that apply in .gitignore files (note that negated\\\\n patterns that begin with ‘!’ are not supported). See\\\\n https://git-scm.com/docs/gitignore#_pattern_format.\\\\n A local-encoding to identify a file’s encoding on the local\\\\n workstation. If '-' is specified for local-encoding,files that match the pattern\\\\n are not transferred.\\\\n A remote-encoding to specify the file’s desired character set on USS.\\\\n This attribute must either match the local encoding or be set to EBCDIC. If set\\\\n to EBCDIC, files are transferred in text mode and converted, otherwise they are\\\\n transferred in binary mode. Remote files are tagged either with the remote\\\\n encoding or as binary.\\\\n\\\\n A .zosattributes file can either be placed in the top-level directory you want\\\\n to upload, or its location can be specified by using the --attributes parameter.\\\\n .zosattributes files that are placed in nested directories are ignored.\\\\n\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputDir\\\\t\\\\t (string)\\\\n\\\\n The local directory path that you want to upload to a USS directory\\\\n\\\\n USSDir\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory to which you want to upload the local directory\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Upload all directories recursively.\\\\n\\\\n --binary-files | --bf (string)\\\\n\\\\n Comma separated list of file names to be uploaded in binary mode. Use this\\\\n option when you upload a directory in default ASCII mode, but you want to\\\\n specify certain files to be uploaded in binary mode. All files matching\\\\n specified file names will be uploaded in binary mode. If a .zosattributes file\\\\n (or equivalent file specified via --attributes) is present, --binary-files will\\\\n be ignored.\\\\n\\\\n --ascii-files | --af (string)\\\\n\\\\n Comma separated list of file names to be uploaded in ASCII mode. Use this option\\\\n when you upload a directory with --binary/-b flag, but you want to specify\\\\n certain files to be uploaded in ASCII mode. All files matching specified file\\\\n names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent\\\\n file specified via --attributes) is present, --ascii-files will be ignored.\\\\n\\\\n --attributes | --attrs (string)\\\\n\\\\n Path of an attributes file to control how files are uploaded\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to upload\\\\n files. Increasing the value results in faster uploads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the upload process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to upload all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory and all its\\\\n sub-directories, to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in default ASCII mode, while specifying a list\\\\n of file names (without path) to be uploaded in binary mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary-files \\\\\\"myFile1.exe,myFile2.exe,myFile3.exe\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in binary mode, while specifying a list of\\\\n file names (without path) to be uploaded in ASCII mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary --ascii-files \\\\\\"myFile1.txt,myFile2.txt,myFile3.txt\\\\\\"\\\\n\\\\n - Recursively upload all files from the \\\\\\"local_dir\\\\\\" directory\\\\n to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory, specifying files to ignore and file\\\\n encodings in the local file my_global_attributes:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive --attributes my_global_attributes\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n dir-to-uss | dtu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload a local directory to a USS directory.\\\\n\\\\n An optional .zosattributes file in the source directory can be used to control\\\\n file conversion and tagging.\\\\n\\\\n An example .zosattributes file:\\\\n # pattern local-encoding remote-encoding\\\\n # Don't upload the node_modules directory\\\\n node_modules -\\\\n # Don't upload files that start with periods\\\\n .* -\\\\n # Upload jpg images in binary\\\\n *.jpg binary binary\\\\n # Convert CICS Node.js profiles to EBCDIC\\\\n *.profile ISO8859-1 EBCDIC\\\\n\\\\n Lines starting with the ‘#’ character are comments. Each line can specify up to\\\\n three positional attributes:\\\\n A pattern to match a set of files. Pattern-matching syntax follows\\\\n the same rules as those that apply in .gitignore files (note that negated\\\\n patterns that begin with ‘!’ are not supported). See\\\\n https://git-scm.com/docs/gitignore#_pattern_format.\\\\n A local-encoding to identify a file’s encoding on the local\\\\n workstation. If '-' is specified for local-encoding,files that match the pattern\\\\n are not transferred.\\\\n A remote-encoding to specify the file’s desired character set on USS.\\\\n This attribute must either match the local encoding or be set to EBCDIC. If set\\\\n to EBCDIC, files are transferred in text mode and converted, otherwise they are\\\\n transferred in binary mode. Remote files are tagged either with the remote\\\\n encoding or as binary.\\\\n\\\\n A .zosattributes file can either be placed in the top-level directory you want\\\\n to upload, or its location can be specified by using the --attributes parameter.\\\\n .zosattributes files that are placed in nested directories are ignored.\\\\n\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload dir-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputDir\\\\t\\\\t (string)\\\\n\\\\n The local directory path that you want to upload to a USS directory\\\\n\\\\n USSDir\\\\t\\\\t (string)\\\\n\\\\n The name of the USS directory to which you want to upload the local directory\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --recursive | -r (boolean)\\\\n\\\\n Upload all directories recursively.\\\\n\\\\n --binary-files | --bf (string)\\\\n\\\\n Comma separated list of file names to be uploaded in binary mode. Use this\\\\n option when you upload a directory in default ASCII mode, but you want to\\\\n specify certain files to be uploaded in binary mode. All files matching\\\\n specified file names will be uploaded in binary mode. If a .zosattributes file\\\\n (or equivalent file specified via --attributes) is present, --binary-files will\\\\n be ignored.\\\\n\\\\n --ascii-files | --af (string)\\\\n\\\\n Comma separated list of file names to be uploaded in ASCII mode. Use this option\\\\n when you upload a directory with --binary/-b flag, but you want to specify\\\\n certain files to be uploaded in ASCII mode. All files matching specified file\\\\n names will be uploaded in ASCII mode. If a .zosattributes file (or equivalent\\\\n file specified via --attributes) is present, --ascii-files will be ignored.\\\\n\\\\n --attributes | --attrs (string)\\\\n\\\\n Path of an attributes file to control how files are uploaded.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to upload\\\\n files. Increasing the value results in faster uploads. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. If the upload process encounters an\\\\n error, the following message displays:\\\\n The maximum number of TSO address spaces have been created. When you specify 0,\\\\n Zowe CLI attempts to upload all members at once without a maximum number of\\\\n concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --include-hidden | --ih (boolean)\\\\n\\\\n Include hidden files and folders that have names beginning with a dot.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory and all its\\\\n sub-directories, to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in default ASCII mode, while specifying a list\\\\n of file names (without path) to be uploaded in binary mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary-files \\\\\\"myFile1.exe,myFile2.exe,myFile3.exe\\\\\\"\\\\n\\\\n - Upload all files from the \\\\\\"local_dir\\\\\\" directory to the\\\\n \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory in binary mode, while specifying a list of\\\\n file names (without path) to be uploaded in ASCII mode:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --binary --ascii-files \\\\\\"myFile1.txt,myFile2.txt,myFile3.txt\\\\\\"\\\\n\\\\n - Recursively upload all files from the \\\\\\"local_dir\\\\\\" directory\\\\n to the \\\\\\"/a/ibmuser/my_dir\\\\\\" USS directory, specifying files to ignore and file\\\\n encodings in the local file my_global_attributes:\\\\n\\\\n $ zowe zos-files upload dir-to-uss \\\\\\"local_dir\\\\\\" \\\\\\"/a/ibmuser/my_dir\\\\\\" --recursive --attributes my_global_attributes\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/upload/ftds/__snapshots__/cli.files.upload.ftds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/upload/ftds/__snapshots__/cli.files.upload.ftds.integration.test.ts.snap index d2d36a9346..4de3fc0536 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/upload/ftds/__snapshots__/cli.files.upload.ftds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/upload/ftds/__snapshots__/cli.files.upload.ftds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Upload file to data set should display the help 1`] = ` DESCRIPTION ----------- - Upload the contents of a file to a z/OS data set + Upload the contents of a file to a z/OS data set. USAGE ----- @@ -183,8 +183,8 @@ exports[`Upload file to data set should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: file-to-data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-data-set | ftds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the contents of a file to a z/OS data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a data set\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload file contents to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Upload file contents to a PDS member named\\\\n \\\\\\"ibmuser.pds(mem)\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Upload file contents to a migrated data set and wait for it\\\\n to be recalled:\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-data-set | ftds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the contents of a file to a z/OS data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a data set\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload file contents to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Upload file contents to a PDS member named\\\\n \\\\\\"ibmuser.pds(mem)\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Upload file contents to a migrated data set and wait for it\\\\n to be recalled:\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-data-set | ftds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the contents of a file to a z/OS data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a data set\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload file contents to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Upload file contents to a PDS member named\\\\n \\\\\\"ibmuser.pds(mem)\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Upload file contents to a migrated data set and wait for it\\\\n to be recalled:\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-data-set | ftds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the contents of a file to a z/OS data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a data set\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload file contents to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Upload file contents to a PDS member named\\\\n \\\\\\"ibmuser.pds(mem)\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Upload file contents to a migrated data set and wait for it\\\\n to be recalled:\\\\n\\\\n $ zowe zos-files upload file-to-data-set \\\\\\"file.txt\\\\\\" \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/upload/ftu/__snapshots__/cli.files.upload.ftu.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/upload/ftu/__snapshots__/cli.files.upload.ftu.integration.test.ts.snap index 25f495aedb..8d37ccd150 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/upload/ftu/__snapshots__/cli.files.upload.ftu.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/upload/ftu/__snapshots__/cli.files.upload.ftu.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Upload uss file should display the help 1`] = ` DESCRIPTION ----------- - Upload content to a USS file from local file + Upload content to a USS file from local file. USAGE ----- @@ -152,8 +152,8 @@ exports[`Upload uss file should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: file-to-uss.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-uss | ftu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload content to a USS file from local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a USS file\\\\n\\\\n USSFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload to the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" from the\\\\n file \\\\\\"file.txt\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-uss \\\\\\"file.txt\\\\\\" \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-uss | ftu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload content to a USS file from local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a USS file\\\\n\\\\n USSFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload to the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" from the\\\\n file \\\\\\"file.txt\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-uss \\\\\\"file.txt\\\\\\" \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-uss | ftu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload content to a USS file from local file\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a USS file\\\\n\\\\n USSFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload to the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" from the\\\\n file \\\\\\"file.txt\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-uss \\\\\\"file.txt\\\\\\" \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n file-to-uss | ftu\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload content to a USS file from local file.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload file-to-uss [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n inputfile\\\\t\\\\t (string)\\\\n\\\\n The local file that you want to upload to a USS file\\\\n\\\\n USSFileName\\\\t\\\\t (string)\\\\n\\\\n The name of the USS file to which you want to upload the file\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --encoding | --ec (string)\\\\n\\\\n Data content in encoding mode, which means that data conversion is performed\\\\n according to the encoding specified.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Upload to the USS file \\\\\\"/a/ibmuser/my_text.txt\\\\\\" from the\\\\n file \\\\\\"file.txt\\\\\\":\\\\n\\\\n $ zowe zos-files upload file-to-uss \\\\\\"file.txt\\\\\\" \\\\\\"/a/ibmuser/my_text.txt\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__integration__/upload/stds/__snapshots__/cli.files.upload.stds.integration.test.ts.snap b/packages/cli/__tests__/zosfiles/__integration__/upload/stds/__snapshots__/cli.files.upload.stds.integration.test.ts.snap index 0b5ebd366f..9854a5978a 100644 --- a/packages/cli/__tests__/zosfiles/__integration__/upload/stds/__snapshots__/cli.files.upload.stds.integration.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__integration__/upload/stds/__snapshots__/cli.files.upload.stds.integration.test.ts.snap @@ -11,7 +11,7 @@ exports[`Upload Data Set should display upload standard input help 1`] = ` DESCRIPTION ----------- - Upload the content of a stdin to a z/OS data set + Upload the content of a stdin to a z/OS data set. USAGE ----- @@ -174,8 +174,8 @@ exports[`Upload Data Set should display upload standard input help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: stdin-to-data-set.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n stdin-to-data-set | stds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the content of a stdin to a z/OS data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload stdin-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload data\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Stream content from stdin to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Stream content from stdin to a partition data set member\\\\n named \\\\\\"ibmuser.pds(mem)\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Stream content from stdin to a migrated data set and wait\\\\n for it to be recalled from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n stdin-to-data-set | stds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the content of a stdin to a z/OS data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload stdin-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload data\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Stream content from stdin to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Stream content from stdin to a partition data set member\\\\n named \\\\\\"ibmuser.pds(mem)\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Stream content from stdin to a migrated data set and wait\\\\n for it to be recalled from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n stdin-to-data-set | stds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the content of a stdin to a z/OS data set\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload stdin-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload data\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Stream content from stdin to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Stream content from stdin to a partition data set member\\\\n named \\\\\\"ibmuser.pds(mem)\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Stream content from stdin to a migrated data set and wait\\\\n for it to be recalled from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n stdin-to-data-set | stds\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Upload the content of a stdin to a z/OS data set.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-files upload stdin-to-data-set [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n dataSetName\\\\t\\\\t (string)\\\\n\\\\n The name of the data set to which you want to upload data\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --binary | -b (boolean)\\\\n\\\\n Data content in binary mode, which means that no data conversion is performed.\\\\n The data transfer process returns each record as-is, without translation. No\\\\n delimiters are added between records.\\\\n\\\\n --migrated-recall | --mr (string)\\\\n\\\\n The method by which migrated data set is handled. By default, a migrated data\\\\n set is recalled synchronously. You can specify the following values: wait,\\\\n nowait, error\\\\n\\\\n Default value: nowait\\\\n\\\\n --record | -r (boolean)\\\\n\\\\n Data content in record mode, which means that no data conversion is performed\\\\n and the record length is prepended to the data. The data transfer process\\\\n returns each line as-is, without translation. No delimiters are added between\\\\n records. Conflicts with binary.\\\\n\\\\n --volume-serial | --vs (string)\\\\n\\\\n The volume serial (VOLSER) where the data set resides. You can use this option\\\\n at any time. However, the VOLSER is required only when the data set is not\\\\n cataloged on the system. A VOLSER is analogous to a drive name on a PC.\\\\n\\\\n --response-timeout | --rto (number)\\\\n\\\\n The maximum amount of time in seconds the z/OSMF Files TSO servlet should run\\\\n before returning a response. Any request exceeding this amount of time will be\\\\n terminated and return an error. Allowed values: 5 - 600\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Stream content from stdin to a sequential data set named\\\\n \\\\\\"ibmuser.ps\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\"\\\\n\\\\n - Stream content from stdin to a partition data set member\\\\n named \\\\\\"ibmuser.pds(mem)\\\\\\" from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.pds(mem)\\\\\\"\\\\n\\\\n - Stream content from stdin to a migrated data set and wait\\\\n for it to be recalled from a Windows console:\\\\n\\\\n $ echo \\\\\\"hello world\\\\\\" | zowe zos-files upload stdin-to-data-set \\\\\\"ibmuser.ps\\\\\\" --mr wait\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/ds/__snapshots__/Dataset.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/ds/__snapshots__/Dataset.definition.unit.test.ts.snap index a0f683f9fb..d6499060de 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/ds/__snapshots__/Dataset.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/ds/__snapshots__/Dataset.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "b", ], - "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.", + "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.", "name": "binary", "type": "boolean", }, @@ -93,7 +93,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-ds/__snapshots__/LocalfileDataset.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-ds/__snapshots__/LocalfileDataset.definition.unit.test.ts.snap index 0d4fa19f8a..68d4509553 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-ds/__snapshots__/LocalfileDataset.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-ds/__snapshots__/LocalfileDataset.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "b", ], - "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.", + "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.", "name": "binary", "type": "boolean", }, @@ -58,7 +58,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, @@ -72,7 +72,7 @@ Array [ "options": "\\"./a.txt\\" \\"sys1.samplib(antxtso)\\"", }, Object { - "description": "Compare the contents of the local file and the data set member \\"./a.txt\\" and \\"sys1.samplib(antxtso)\\"without sequence numbers", + "description": "Compare the contents of the local file and the data set member \\"./a.txt\\" and \\"sys1.samplib(antxtso)\\" without sequence numbers", "options": "\\"./a.txt\\" \\"sys1.samplib(antxtso)\\" --no-seqnum", }, ] diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-sdd/__snapshots__/LocalfileSpooldd.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-sdd/__snapshots__/LocalfileSpooldd.definition.unit.test.ts.snap index 984258e108..1603b58f14 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-sdd/__snapshots__/LocalfileSpooldd.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-sdd/__snapshots__/LocalfileSpooldd.definition.unit.test.ts.snap @@ -23,7 +23,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, @@ -37,7 +37,7 @@ Array [ "options": "\\"./a.txt\\" \\"jobName:jobId:spoolId\\"", }, Object { - "description": "Compare the contents of a local-file and a spool dd \\"./a.txt\\" \\"jobName:jobId:spoolId\\"without sequence numbers", + "description": "Compare the contents of a local-file and a spool dd \\"./a.txt\\" \\"jobName:jobId:spoolId\\" without sequence numbers", "options": "\\"./a.txt\\" \\"jobName:jobId:spoolId\\" --no-seqnum", }, ] diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-uss/__snapshots__/LocalfileUss.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-uss/__snapshots__/LocalfileUss.definition.unit.test.ts.snap index 87149f2954..5d61de9a25 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/lf-uss/__snapshots__/LocalfileUss.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/lf-uss/__snapshots__/LocalfileUss.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "b", ], - "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.", + "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.", "name": "binary", "type": "boolean", }, @@ -39,7 +39,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, @@ -49,11 +49,11 @@ Array [ exports[`zos-files compare lfuss command definition should not have changed 2`] = ` Array [ Object { - "description": "Compare the contents of the local file and the uss file \\"./a.txt\\" and \\"/u/user/test.txt\\"", + "description": "Compare the contents of the local file and the USS file \\"./a.txt\\" and \\"/u/user/test.txt\\"", "options": "\\"./a.txt\\" \\"/u/user/test.txt\\"", }, Object { - "description": "Compare the contents of the local file and the uss file \\"./a.txt\\" and \\"/u/user/test.txt\\"without sequence numbers", + "description": "Compare the contents of the local file and the USS file \\"./a.txt\\" and \\"/u/user/test.txt\\" without sequence numbers", "options": "\\"./a.txt\\" \\"/u/user/test.txt\\" --no-seqnum", }, ] diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/sdd/__snapshots__/Spooldd.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/sdd/__snapshots__/Spooldd.definition.unit.test.ts.snap index 8d3537e11d..d867a1fc48 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/sdd/__snapshots__/Spooldd.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/sdd/__snapshots__/Spooldd.definition.unit.test.ts.snap @@ -14,7 +14,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, @@ -28,7 +28,7 @@ Array [ "options": "\\"jobName1:jobId1:spoolId1\\" \\"jobName2:jobId2:spoolId2\\"", }, Object { - "description": "Compare the contents of the two spool dds \\"jobName1:jobId1:spoolId1\\" \\"jobName2:jobId2:spoolId2\\"without sequence numbers", + "description": "Compare the contents of the two spool dds \\"jobName1:jobId1:spoolId1\\" \\"jobName2:jobId2:spoolId2\\" without sequence numbers", "options": "\\"jobName1:jobId1:spoolId1\\" \\"jobName2:jobId2:spoolId2\\" --no-seqnum", }, ] diff --git a/packages/cli/__tests__/zosfiles/__unit__/compare/uss/__snapshots__/UssFile.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/compare/uss/__snapshots__/UssFile.definition.unit.test.ts.snap index 0da21e519a..286bd11fe2 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/compare/uss/__snapshots__/UssFile.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/compare/uss/__snapshots__/UssFile.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "b", ], - "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both datasets are transferred in binary mode.", + "description": "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set and the binary2 flag is not set then both data sets are transferred in binary mode.", "name": "binary", "type": "boolean", }, @@ -55,7 +55,7 @@ Array [ "aliases": Array [ "bv", ], - "description": "Opens the diffs between two given files in browser", + "description": "Opens the diffs between two given files in browser.", "name": "browser-view", "type": "boolean", }, @@ -65,11 +65,11 @@ Array [ exports[`zos-files compare uss command definition should not have changed 2`] = ` Array [ Object { - "description": "Compare the contents of the uss file \\"/u/user/test.txt\\" and \\"/u/user/test.txt\\"", + "description": "Compare the contents of the USS file \\"/u/user/test.txt\\" and \\"/u/user/test.txt\\"", "options": "\\"/u/user/test.txt\\" \\"/u/user/test.txt\\"", }, Object { - "description": "Compare the contents of the uss file \\"/u/user/test.txt\\" and \\"/u/user/test.txt\\" without sequence numbers", + "description": "Compare the contents of the USS file \\"/u/user/test.txt\\" and \\"/u/user/test.txt\\" without sequence numbers", "options": "\\"/u/user/test.txt\\" \\"/u/user/test.txt\\" --no-seqnum", }, ] diff --git a/packages/cli/__tests__/zosfiles/__unit__/copy/ds/__snapshots__/Ds.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/copy/ds/__snapshots__/Ds.definition.unit.test.ts.snap index 6a8ad19cb2..cee4e8287e 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/copy/ds/__snapshots__/Ds.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/copy/ds/__snapshots__/Ds.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "rep", ], - "description": "Specify this option as true if you wish to replace like-named members in the target dataset", + "description": "Specify this option as true if you wish to replace like-named members in the target data set", "name": "replace", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/__snapshots__/Dsclp.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/__snapshots__/Dsclp.definition.unit.test.ts.snap index 552958b81d..ce6568b172 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/__snapshots__/Dsclp.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/copy/dsclp/__snapshots__/Dsclp.definition.unit.test.ts.snap @@ -6,7 +6,7 @@ Array [ "aliases": Array [ "rep", ], - "description": "Specify this option as true if you wish to replace the target dataset if it already exists", + "description": "Specify this option as true if you wish to replace the target data set if it already exists.", "name": "replace", "type": "boolean", }, @@ -96,7 +96,7 @@ Array [ "t-zosmf-p", "target-zosmf-p", ], - "description": "The name of a z/OSMF profile to load for the target host. ", + "description": "The name of a z/OSMF profile to load for the target host.", "name": "target-zosmf-profile", "type": "string", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/download/am/__snapshots__/AllMembers.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/download/am/__snapshots__/AllMembers.definition.unit.test.ts.snap index b5558119bc..57a09ae7ec 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/download/am/__snapshots__/AllMembers.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/download/am/__snapshots__/AllMembers.definition.unit.test.ts.snap @@ -39,7 +39,7 @@ Array [ "ff", ], "defaultValue": true, - "description": "Set this option to false to continue downloading dataset members if one or more fail.", + "description": "Set this option to false to continue downloading data set members if one or more fail.", "name": "fail-fast", "type": "boolean", }, @@ -62,7 +62,7 @@ The maximum number of TSO address spaces have been created. When you specify 0, "po", ], "defaultValue": false, - "description": "Specifies if the automatically generated directories and files use the original letter case", + "description": "Specifies if the automatically generated directories and files use the original letter case.", "name": "preserve-original-letter-case", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/download/ds/__snapshots__/Dataset.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/download/ds/__snapshots__/Dataset.definition.unit.test.ts.snap index b0de96b836..5722077e2b 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/download/ds/__snapshots__/Dataset.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/download/ds/__snapshots__/Dataset.definition.unit.test.ts.snap @@ -39,7 +39,7 @@ Array [ "po", ], "defaultValue": false, - "description": "Specifies if the automatically generated directories and files use the original letter case", + "description": "Specifies if the automatically generated directories and files use the original letter case.", "name": "preserve-original-letter-case", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/download/dsm/__snapshots__/DataSetMatching.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/download/dsm/__snapshots__/DataSetMatching.definition.unit.test.ts.snap index 9f784aba6c..39d86bc1a1 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/download/dsm/__snapshots__/DataSetMatching.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/download/dsm/__snapshots__/DataSetMatching.definition.unit.test.ts.snap @@ -58,7 +58,7 @@ Array [ "ff", ], "defaultValue": true, - "description": "Set this option to false to continue downloading dataset members if one or more fail.", + "description": "Set this option to false to continue downloading data set members if one or more fail.", "name": "fail-fast", "type": "boolean", }, @@ -81,7 +81,7 @@ The maximum number of TSO address spaces have been created. When you specify 0, "po", ], "defaultValue": false, - "description": "Specifies if the automatically generated directories and files use the original letter case", + "description": "Specifies if the automatically generated directories and files use the original letter case.", "name": "preserve-original-letter-case", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/download/ussdir/__snapshots__/UssDir.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/download/ussdir/__snapshots__/UssDir.definition.unit.test.ts.snap index b1820ecad0..be114a65b4 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/download/ussdir/__snapshots__/UssDir.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/download/ussdir/__snapshots__/UssDir.definition.unit.test.ts.snap @@ -10,7 +10,7 @@ Array [ "binary", "record", ], - "description": "Path of an attributes file to control how files are downloaded", + "description": "Path of an attributes file to control how files are downloaded.", "name": "attributes", "type": "existingLocalFile", }, @@ -66,7 +66,7 @@ Array [ "aliases": Array [ "ih", ], - "description": "Include hidden files and folders that have names beginning with a dot", + "description": "Include hidden files and folders that have names beginning with a dot.", "name": "include-hidden", "type": "boolean", }, @@ -106,7 +106,7 @@ The maximum number of TSO address spaces have been created. When you specify 0, "aliases": Array [ "ow", ], - "description": "Overwrite files that already exist in your local environment", + "description": "Overwrite files that already exist in your local environment.", "name": "overwrite", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosfiles/__unit__/upload/dtu/__snapshots__/DirToUSS.definition.unit.test.ts.snap b/packages/cli/__tests__/zosfiles/__unit__/upload/dtu/__snapshots__/DirToUSS.definition.unit.test.ts.snap index dbefb890e9..a3bbedd0b9 100644 --- a/packages/cli/__tests__/zosfiles/__unit__/upload/dtu/__snapshots__/DirToUSS.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosfiles/__unit__/upload/dtu/__snapshots__/DirToUSS.definition.unit.test.ts.snap @@ -47,7 +47,7 @@ Array [ "conflictsWith": Array [ "ascii-files, binary-files", ], - "description": "Path of an attributes file to control how files are uploaded", + "description": "Path of an attributes file to control how files are uploaded.", "name": "attributes", "type": "string", }, @@ -69,7 +69,7 @@ The maximum number of TSO address spaces have been created. When you specify 0, "aliases": Array [ "ih", ], - "description": "Include hidden files and folders that have names beginning with a dot", + "description": "Include hidden files and folders that have names beginning with a dot.", "name": "include-hidden", "type": "boolean", }, diff --git a/packages/cli/__tests__/zosjobs/__integration__/cancel/__snapshots__/cli.zos-jobs.cancel.job.integration.test.ts.snap b/packages/cli/__tests__/zosjobs/__integration__/cancel/__snapshots__/cli.zos-jobs.cancel.job.integration.test.ts.snap index a57febf0df..2340d86174 100644 --- a/packages/cli/__tests__/zosjobs/__integration__/cancel/__snapshots__/cli.zos-jobs.cancel.job.integration.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__integration__/cancel/__snapshots__/cli.zos-jobs.cancel.job.integration.test.ts.snap @@ -28,7 +28,7 @@ exports[`zos-jobs cancel job command should display the help 1`] = ` DESCRIPTION ----------- - Cancel a single job by job ID + Cancel a single job by job ID. USAGE ----- @@ -50,7 +50,7 @@ exports[`zos-jobs cancel job command should display the help 1`] = ` --modify-version (string) Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete - job API aynchronous. Otherwise, it will be synchronous by default. + job API asynchronous. Otherwise, it will be synchronous by default. Default value: 2.0 @@ -159,8 +159,8 @@ exports[`zos-jobs cancel job command should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: job.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Cancel a single job by job ID\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs cancel job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Cancel job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456\\\\n\\\\n - Cancel job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Cancel a single job by job ID.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs cancel job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Cancel job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456\\\\n\\\\n - Cancel job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Cancel a single job by job ID\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs cancel job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Cancel job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456\\\\n\\\\n - Cancel job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Cancel a single job by job ID.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs cancel job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Cancel job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456\\\\n\\\\n - Cancel job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs cancel job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.job.integration.test.ts.snap b/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.job.integration.test.ts.snap index 78788c1c6e..1073ac991b 100644 --- a/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.job.integration.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.job.integration.test.ts.snap @@ -28,7 +28,7 @@ exports[`zos-jobs delete job command should display the help 1`] = ` DESCRIPTION ----------- - Delete a single job by job ID + Delete a single job by job ID. USAGE ----- @@ -50,7 +50,7 @@ exports[`zos-jobs delete job command should display the help 1`] = ` --modify-version (string) Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete - job API aynchronous. Otherwise, it will be synchronous by default. + job API asynchronous. Otherwise, it will be synchronous by default. Default value: 2.0 @@ -159,8 +159,8 @@ exports[`zos-jobs delete job command should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: job.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a single job by job ID\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456\\\\n\\\\n - Delete job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a single job by job ID.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456\\\\n\\\\n - Delete job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a single job by job ID\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456\\\\n\\\\n - Delete job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n job\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete a single job by job ID.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete job [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n jobid\\\\t\\\\t (string)\\\\n\\\\n The job ID (e.g. JOB00123) of the job. Job ID is a unique identifier for z/OS\\\\n batch jobs -- no two jobs on one system can have the same ID. Note: z/OS allows\\\\n you to abbreviate the job ID if desired. You can use, for example \\\\\\"J123\\\\\\".\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete job with job ID JOB03456:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456\\\\n\\\\n - Delete job with job ID JOB03456 synchronously:\\\\n\\\\n $ zowe zos-jobs delete job JOB03456 --modify-version \\\\\\"2.0\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.old-jobs.integration.test.ts.snap b/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.old-jobs.integration.test.ts.snap index a136e6d03e..2f99957640 100644 --- a/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.old-jobs.integration.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__integration__/delete/__snapshots__/cli.zos-jobs.delete.old-jobs.integration.test.ts.snap @@ -63,7 +63,7 @@ exports[`zos-jobs delete old-jobs command should display the help 1`] = ` --modify-version (string) Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete - job API aynchronous. Otherwise, it will be synchronous by default. + job API asynchronous. Otherwise, it will be synchronous by default. Default value: 2.0 @@ -169,8 +169,8 @@ exports[`zos-jobs delete old-jobs command should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: old-jobs.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n old-jobs | oj\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by\\\\n your user ID that are in output status.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete old-jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Only delete jobs with job names that match this prefix. Defaults to deleting all\\\\n jobs owned by your user ID that are in output status.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to delete\\\\n jobs. Increasing the value makes the command run faster. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. When you specify 0, Zowe CLI attempts to\\\\n delete all jobs at once without a maximum number of concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete all of your jobs in output status with a job name\\\\n starting with \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-jobs delete old-jobs -p \\\\\\"ibmuser*\\\\\\"\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n old-jobs | oj\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by\\\\n your user ID that are in output status.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete old-jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Only delete jobs with job names that match this prefix. Defaults to deleting all\\\\n jobs owned by your user ID that are in output status.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to delete\\\\n jobs. Increasing the value makes the command run faster. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. When you specify 0, Zowe CLI attempts to\\\\n delete all jobs at once without a maximum number of concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete all of your jobs in output status with a job name\\\\n starting with \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-jobs delete old-jobs -p \\\\\\"ibmuser*\\\\\\"\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n old-jobs | oj\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by\\\\n your user ID that are in output status.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete old-jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Only delete jobs with job names that match this prefix. Defaults to deleting all\\\\n jobs owned by your user ID that are in output status.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to delete\\\\n jobs. Increasing the value makes the command run faster. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. When you specify 0, Zowe CLI attempts to\\\\n delete all jobs at once without a maximum number of concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API aynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete all of your jobs in output status with a job name\\\\n starting with \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-jobs delete old-jobs -p \\\\\\"ibmuser*\\\\\\"\\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n old-jobs | oj\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Delete (purge) jobs in OUTPUT status. Defaults to deleting all jobs owned by\\\\n your user ID that are in output status.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-jobs delete old-jobs [options]\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --prefix | -p (string)\\\\n\\\\n Only delete jobs with job names that match this prefix. Defaults to deleting all\\\\n jobs owned by your user ID that are in output status.\\\\n\\\\n --max-concurrent-requests | --mcr (number)\\\\n\\\\n Specifies the maximum number of concurrent z/OSMF REST API requests to delete\\\\n jobs. Increasing the value makes the command run faster. However, increasing the\\\\n value increases resource consumption on z/OS and can be prone to errors caused\\\\n by making too many concurrent requests. When you specify 0, Zowe CLI attempts to\\\\n delete all jobs at once without a maximum number of concurrent requests.\\\\n\\\\n Default value: 1\\\\n\\\\n --modify-version (string)\\\\n\\\\n Using this option to set X-IBM-Job-Modify-Version to \\\\\\"1.0\\\\\\" will make the delete\\\\n job API asynchronous. Otherwise, it will be synchronous by default.\\\\n\\\\n Default value: 2.0\\\\n\\\\n ZOSMF CONNECTION OPTIONS\\\\n ------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OSMF server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OSMF server port.\\\\n\\\\n Default value: 443\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe (z/OSMF) user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe (z/OSMF) password, which can be the same as your TSO password.\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --base-path | --bp (string)\\\\n\\\\n The base path for your API mediation layer instance. Specify this option to\\\\n prepend the base path to all z/OSMF resources when making REST requests. Do not\\\\n specify this option if you are not using an API mediation layer.\\\\n\\\\n --protocol (string)\\\\n\\\\n The protocol used (HTTP or HTTPS)\\\\n\\\\n Default value: https\\\\n Allowed values: http, https\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --zosmf-profile | --zosmf-p (string)\\\\n\\\\n The name of a (zosmf) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Delete all of your jobs in output status with a job name\\\\n starting with \\\\\\"ibmuser\\\\\\":\\\\n\\\\n $ zowe zos-jobs delete old-jobs -p \\\\\\"ibmuser*\\\\\\"\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosjobs/__unit__/cancel/job/__snapshots__/Job.definition.unit.test.ts.snap b/packages/cli/__tests__/zosjobs/__unit__/cancel/job/__snapshots__/Job.definition.unit.test.ts.snap index 7604d60dca..af09561c63 100644 --- a/packages/cli/__tests__/zosjobs/__unit__/cancel/job/__snapshots__/Job.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__unit__/cancel/job/__snapshots__/Job.definition.unit.test.ts.snap @@ -2,7 +2,7 @@ exports[`zos-jobs cancel job definition should not have changed 1`] = ` Object { - "description": "Cancel a single job by job ID", + "description": "Cancel a single job by job ID.", "examples": Array [ Object { "description": "Cancel job with job ID JOB03456", @@ -17,7 +17,7 @@ Object { "options": Array [ Object { "defaultValue": "2.0", - "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.", + "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API asynchronous. Otherwise, it will be synchronous by default.", "name": "modify-version", "required": false, "type": "string", diff --git a/packages/cli/__tests__/zosjobs/__unit__/delete/job/__snapshots__/Job.definition.unit.test.ts.snap b/packages/cli/__tests__/zosjobs/__unit__/delete/job/__snapshots__/Job.definition.unit.test.ts.snap index 3ea73b0516..cbd5826b09 100644 --- a/packages/cli/__tests__/zosjobs/__unit__/delete/job/__snapshots__/Job.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__unit__/delete/job/__snapshots__/Job.definition.unit.test.ts.snap @@ -2,7 +2,7 @@ exports[`zos-jobs delete job definition should not have changed 1`] = ` Object { - "description": "Delete a single job by job ID", + "description": "Delete a single job by job ID.", "examples": Array [ Object { "description": "Delete job with job ID JOB03456", @@ -17,7 +17,7 @@ Object { "options": Array [ Object { "defaultValue": "2.0", - "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.", + "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API asynchronous. Otherwise, it will be synchronous by default.", "name": "modify-version", "required": false, "type": "string", diff --git a/packages/cli/__tests__/zosjobs/__unit__/delete/old-jobs/__snapshots__/OldJobs.definition.unit.test.ts.snap b/packages/cli/__tests__/zosjobs/__unit__/delete/old-jobs/__snapshots__/OldJobs.definition.unit.test.ts.snap index e9ff3a6923..99624657e7 100644 --- a/packages/cli/__tests__/zosjobs/__unit__/delete/old-jobs/__snapshots__/OldJobs.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosjobs/__unit__/delete/old-jobs/__snapshots__/OldJobs.definition.unit.test.ts.snap @@ -33,7 +33,7 @@ Object { }, Object { "defaultValue": "2.0", - "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API aynchronous. Otherwise, it will be synchronous by default.", + "description": "Using this option to set X-IBM-Job-Modify-Version to \\"1.0\\" will make the delete job API asynchronous. Otherwise, it will be synchronous by default.", "name": "modify-version", "required": false, "type": "string", diff --git a/packages/cli/__tests__/zosmf/__unit__/check/__snapshots__/Check.definition.unit.test.ts.snap b/packages/cli/__tests__/zosmf/__unit__/check/__snapshots__/Check.definition.unit.test.ts.snap index 5fc3fa2e05..841d78380f 100644 --- a/packages/cli/__tests__/zosmf/__unit__/check/__snapshots__/Check.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosmf/__unit__/check/__snapshots__/Check.definition.unit.test.ts.snap @@ -2,8 +2,9 @@ exports[`zosmf check group definition should have the right command content 1`] = ` Object { - "description": "Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes. ", + "description": "Confirm that z/OSMF is running on a specified system and gather information about the z/OSMF server for diagnostic purposes.", "name": "check", + "summary": "Check z/OSMF status on a specified system", "type": "group", } `; diff --git a/packages/cli/__tests__/zosmf/__unit__/check/status/__snapshots__/Status.definition.unit.test.ts.snap b/packages/cli/__tests__/zosmf/__unit__/check/status/__snapshots__/Status.definition.unit.test.ts.snap index 79bc1b5523..e693e39a2b 100644 --- a/packages/cli/__tests__/zosmf/__unit__/check/status/__snapshots__/Status.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosmf/__unit__/check/status/__snapshots__/Status.definition.unit.test.ts.snap @@ -111,6 +111,7 @@ Object { "zosmf", ], }, + "summary": "Check z/OSMF status on a specified system", "type": "command", } `; diff --git a/packages/cli/__tests__/zosmf/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap b/packages/cli/__tests__/zosmf/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap index cd0df77044..25b6a4bc04 100644 --- a/packages/cli/__tests__/zosmf/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosmf/__unit__/list/__snapshots__/List.definition.unit.test.ts.snap @@ -4,6 +4,7 @@ exports[`zosmf list group definition should have the right command content 1`] = Object { "description": "Obtain a list of systems that are defined to a z/OSMF instance.", "name": "list", + "summary": "Obtain a list of systems that are defined to a z/OSMF instance", "type": "group", } `; diff --git a/packages/cli/__tests__/zosmf/__unit__/list/systems/__snapshots__/Systems.definition.unit.test.ts.snap b/packages/cli/__tests__/zosmf/__unit__/list/systems/__snapshots__/Systems.definition.unit.test.ts.snap index f2d317d9ed..e295912cbe 100644 --- a/packages/cli/__tests__/zosmf/__unit__/list/systems/__snapshots__/Systems.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosmf/__unit__/list/systems/__snapshots__/Systems.definition.unit.test.ts.snap @@ -111,6 +111,7 @@ Object { "zosmf", ], }, + "summary": "Obtain a list of systems that are defined to a z/OSMF instance", "type": "command", } `; diff --git a/packages/cli/__tests__/zostso/__integration__/start/__snapshots__/cli.zos-tso.start.integration.test.ts.snap b/packages/cli/__tests__/zostso/__integration__/start/__snapshots__/cli.zos-tso.start.integration.test.ts.snap index 97ae6639ae..1f08304a7a 100644 --- a/packages/cli/__tests__/zostso/__integration__/start/__snapshots__/cli.zos-tso.start.integration.test.ts.snap +++ b/packages/cli/__tests__/zostso/__integration__/start/__snapshots__/cli.zos-tso.start.integration.test.ts.snap @@ -17,9 +17,7 @@ exports[`zos-tso start should display the help 1`] = ` COMMANDS -------- - address-space | as Start a TSO address space, from which you will receive a - token (a.k.a 'servlet-key') for further address space - interaction (e.g. termination). + address-space | as Start a TSO address space GLOBAL OPTIONS -------------- @@ -44,8 +42,8 @@ exports[`zos-tso start should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: start.\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Start TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso start \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Start a TSO address space, from which you will receive a\\\\n token (a.k.a 'servlet-key') for further address space \\\\n interaction (e.g. termination). \\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Start TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso start \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Start a TSO address space\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Start TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso start \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Start a TSO address space, from which you will receive a\\\\n token (a.k.a 'servlet-key') for further address space \\\\n interaction (e.g. termination). \\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Start TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso start \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Start a TSO address space\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zostso/__integration__/stop/__snapshots__/cli.zos-tso.stop.integration.test.ts.snap b/packages/cli/__tests__/zostso/__integration__/stop/__snapshots__/cli.zos-tso.stop.integration.test.ts.snap index c22d7fea51..16e1198999 100644 --- a/packages/cli/__tests__/zostso/__integration__/stop/__snapshots__/cli.zos-tso.stop.integration.test.ts.snap +++ b/packages/cli/__tests__/zostso/__integration__/stop/__snapshots__/cli.zos-tso.stop.integration.test.ts.snap @@ -17,8 +17,7 @@ exports[`zos-tso stop should display the help 1`] = ` COMMANDS -------- - address-space | as Stop a TSO address space, from which you previously started - and received a token (a.k.a 'servlet-key'). + address-space | as Stop a TSO address space GLOBAL OPTIONS -------------- @@ -43,8 +42,8 @@ exports[`zos-tso stop should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: stop.\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Stop TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso stop \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Stop a TSO address space, from which you previously started\\\\n and received a token (a.k.a 'servlet-key'). \\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Stop TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso stop \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Stop a TSO address space\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Stop TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso stop \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Stop a TSO address space, from which you previously started\\\\n and received a token (a.k.a 'servlet-key'). \\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" + \\"data\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Stop TSO/E address space.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-tso stop \\\\n\\\\n Where is one of the following:\\\\n\\\\n COMMANDS\\\\n --------\\\\n\\\\n address-space | as Stop a TSO address space\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --help-examples (boolean)\\\\n\\\\n Display examples for all the commands in a group\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zostso/__unit__/start/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap b/packages/cli/__tests__/zostso/__unit__/start/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap index fbe886bc40..84fa3ed18b 100644 --- a/packages/cli/__tests__/zostso/__unit__/start/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zostso/__unit__/start/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap @@ -104,6 +104,7 @@ Object { "tso", ], }, + "summary": "Start a TSO address space", "type": "command", } `; diff --git a/packages/cli/__tests__/zostso/__unit__/stop/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap b/packages/cli/__tests__/zostso/__unit__/stop/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap index 3e7c4c8f8b..3b152c9d65 100644 --- a/packages/cli/__tests__/zostso/__unit__/stop/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zostso/__unit__/stop/address-space/__snapshots__/AddressSpace.definition.unit.test.ts.snap @@ -26,6 +26,7 @@ Object { "zosmf", ], }, + "summary": "Stop a TSO address space", "type": "command", } `; diff --git a/packages/cli/__tests__/zosuss/__integration__/issue/__snapshots__/cli.zos-uss.issue.ssh.integration.test.ts.snap b/packages/cli/__tests__/zosuss/__integration__/issue/__snapshots__/cli.zos-uss.issue.ssh.integration.test.ts.snap index 3b2ea7ef42..42bd40b90b 100644 --- a/packages/cli/__tests__/zosuss/__integration__/issue/__snapshots__/cli.zos-uss.issue.ssh.integration.test.ts.snap +++ b/packages/cli/__tests__/zosuss/__integration__/issue/__snapshots__/cli.zos-uss.issue.ssh.integration.test.ts.snap @@ -26,14 +26,14 @@ exports[`zos-uss issue ssh command should display the help 1`] = ` command (string) - z/OS USS command to issue + z/OS USS command to issue. OPTIONS ------- --cwd (string) - Working directory in which to execute the command + Working directory in which to execute the command. Z/OS SSH CONNECTION OPTIONS --------------------------- @@ -136,8 +136,8 @@ exports[`zos-uss issue ssh command should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"The help was constructed for command: command.\\", - \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n command | cmd | ssh\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Issue a z/OS USS command\\\\n\\\\n Note: The common CLI 'Base Connection Options' of token-type and token-value are\\\\n not applicable to the ssh command, since the ssh service is not accessible\\\\n through APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-ssh issue command [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n command\\\\t\\\\t (string)\\\\n\\\\n z/OS USS command to issue\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --cwd (string)\\\\n\\\\n Working directory in which to execute the command\\\\n\\\\n Z/OS SSH CONNECTION OPTIONS\\\\n ---------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OS SSH server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OS SSH server port.\\\\n\\\\n Default value: 22\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe password, which can be the same as your TSO password.\\\\n\\\\n --privateKey | --key | --pk (string)\\\\n\\\\n Path to a file containing your private key, that must match a public key stored\\\\n in the server for authentication\\\\n\\\\n --keyPassphrase | --passphrase | --kp (string)\\\\n\\\\n Private key passphrase, which unlocks the private key.\\\\n\\\\n --handshakeTimeout | --timeout | --to (number)\\\\n\\\\n How long in milliseconds to wait for the SSH handshake to complete.\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --ssh-profile | --ssh-p (string)\\\\n\\\\n The name of a (ssh) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Issue a simple command, giving the working directory:\\\\n\\\\n $ zowe zos-ssh issue command \\\\\\"npm install express\\\\\\" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp \\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n command | cmd | ssh\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Issue a z/OS USS command\\\\n\\\\n Note: The common CLI 'Base Connection Options' of token-type and token-value are\\\\n not applicable to the ssh command, since the ssh service is not accessible\\\\n through APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-ssh issue command [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n command\\\\t\\\\t (string)\\\\n\\\\n z/OS USS command to issue.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --cwd (string)\\\\n\\\\n Working directory in which to execute the command.\\\\n\\\\n Z/OS SSH CONNECTION OPTIONS\\\\n ---------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OS SSH server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OS SSH server port.\\\\n\\\\n Default value: 22\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe password, which can be the same as your TSO password.\\\\n\\\\n --privateKey | --key | --pk (string)\\\\n\\\\n Path to a file containing your private key, that must match a public key stored\\\\n in the server for authentication\\\\n\\\\n --keyPassphrase | --passphrase | --kp (string)\\\\n\\\\n Private key passphrase, which unlocks the private key.\\\\n\\\\n --handshakeTimeout | --timeout | --to (number)\\\\n\\\\n How long in milliseconds to wait for the SSH handshake to complete.\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --ssh-profile | --ssh-p (string)\\\\n\\\\n The name of a (ssh) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Issue a simple command, giving the working directory:\\\\n\\\\n $ zowe zos-ssh issue command \\\\\\"npm install express\\\\\\" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp \\\\n\\\\n\\", \\"stderr\\": \\"\\", - \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n command | cmd | ssh\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Issue a z/OS USS command\\\\n\\\\n Note: The common CLI 'Base Connection Options' of token-type and token-value are\\\\n not applicable to the ssh command, since the ssh service is not accessible\\\\n through APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-ssh issue command [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n command\\\\t\\\\t (string)\\\\n\\\\n z/OS USS command to issue\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --cwd (string)\\\\n\\\\n Working directory in which to execute the command\\\\n\\\\n Z/OS SSH CONNECTION OPTIONS\\\\n ---------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OS SSH server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OS SSH server port.\\\\n\\\\n Default value: 22\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe password, which can be the same as your TSO password.\\\\n\\\\n --privateKey | --key | --pk (string)\\\\n\\\\n Path to a file containing your private key, that must match a public key stored\\\\n in the server for authentication\\\\n\\\\n --keyPassphrase | --passphrase | --kp (string)\\\\n\\\\n Private key passphrase, which unlocks the private key.\\\\n\\\\n --handshakeTimeout | --timeout | --to (number)\\\\n\\\\n How long in milliseconds to wait for the SSH handshake to complete.\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --ssh-profile | --ssh-p (string)\\\\n\\\\n The name of a (ssh) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Issue a simple command, giving the working directory:\\\\n\\\\n $ zowe zos-ssh issue command \\\\\\"npm install express\\\\\\" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp \\\\n\\\\n\\" + \\"data\\": \\"\\\\n COMMAND NAME\\\\n ------------\\\\n\\\\n command | cmd | ssh\\\\n\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n Issue a z/OS USS command\\\\n\\\\n Note: The common CLI 'Base Connection Options' of token-type and token-value are\\\\n not applicable to the ssh command, since the ssh service is not accessible\\\\n through APIML.\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n zowe zos-ssh issue command [options]\\\\n\\\\n POSITIONAL ARGUMENTS\\\\n --------------------\\\\n\\\\n command\\\\t\\\\t (string)\\\\n\\\\n z/OS USS command to issue.\\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --cwd (string)\\\\n\\\\n Working directory in which to execute the command.\\\\n\\\\n Z/OS SSH CONNECTION OPTIONS\\\\n ---------------------------\\\\n\\\\n --host | -H (string)\\\\n\\\\n The z/OS SSH server host name.\\\\n\\\\n --port | -P (number)\\\\n\\\\n The z/OS SSH server port.\\\\n\\\\n Default value: 22\\\\n\\\\n --user | -u (string)\\\\n\\\\n Mainframe user name, which can be the same as your TSO login.\\\\n\\\\n --password | --pass | --pw (string)\\\\n\\\\n Mainframe password, which can be the same as your TSO password.\\\\n\\\\n --privateKey | --key | --pk (string)\\\\n\\\\n Path to a file containing your private key, that must match a public key stored\\\\n in the server for authentication\\\\n\\\\n --keyPassphrase | --passphrase | --kp (string)\\\\n\\\\n Private key passphrase, which unlocks the private key.\\\\n\\\\n --handshakeTimeout | --timeout | --to (number)\\\\n\\\\n How long in milliseconds to wait for the SSH handshake to complete.\\\\n\\\\n PROFILE OPTIONS\\\\n ---------------\\\\n\\\\n --ssh-profile | --ssh-p (string)\\\\n\\\\n The name of a (ssh) profile to load for this command execution.\\\\n\\\\n --base-profile | --base-p (string)\\\\n\\\\n The name of a (base) profile to load for this command execution.\\\\n\\\\n BASE CONNECTION OPTIONS\\\\n -----------------------\\\\n\\\\n --reject-unauthorized | --ru (boolean)\\\\n\\\\n Reject self-signed certificates.\\\\n\\\\n Default value: true\\\\n\\\\n --token-type | --tt (string)\\\\n\\\\n The type of token to get and use for the API. Omit this option to use the\\\\n default token type, which is provided by 'zowe auth login'.\\\\n\\\\n --token-value | --tv (string)\\\\n\\\\n The value of the token to pass to the API.\\\\n\\\\n --cert-file (local file path)\\\\n\\\\n The file path to a certificate file to use for authentication\\\\n\\\\n --cert-key-file (local file path)\\\\n\\\\n The file path to a certificate key file to use for authentication\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --show-inputs-only (boolean)\\\\n\\\\n Show command inputs and do not run the command\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n EXAMPLES\\\\n --------\\\\n\\\\n - Issue a simple command, giving the working directory:\\\\n\\\\n $ zowe zos-ssh issue command \\\\\\"npm install express\\\\\\" --cwd /u/cicprov/mnt/CICPY01I/bundles/myapp \\\\n\\\\n\\" }" `; diff --git a/packages/cli/__tests__/zosuss/__unit__/issue/ssh/__snapshots__/Ssh.definition.unit.test.ts.snap b/packages/cli/__tests__/zosuss/__unit__/issue/ssh/__snapshots__/Ssh.definition.unit.test.ts.snap index 7c8232b0e6..4a46c638fa 100644 --- a/packages/cli/__tests__/zosuss/__unit__/issue/ssh/__snapshots__/Ssh.definition.unit.test.ts.snap +++ b/packages/cli/__tests__/zosuss/__unit__/issue/ssh/__snapshots__/Ssh.definition.unit.test.ts.snap @@ -3,7 +3,7 @@ exports[`zos-uss issue ssh command definition should not have changed 1`] = ` Array [ Object { - "description": "Working directory in which to execute the command", + "description": "Working directory in which to execute the command.", "name": "cwd", "type": "string", }, diff --git a/packages/cli/src/daemon/disable/Disable.definition.ts b/packages/cli/src/daemon/disable/Disable.definition.ts index 0e58916f9e..85d821222f 100644 --- a/packages/cli/src/daemon/disable/Disable.definition.ts +++ b/packages/cli/src/daemon/disable/Disable.definition.ts @@ -13,7 +13,8 @@ import { ICommandDefinition } from "@zowe/imperative"; export const DisableCommand: ICommandDefinition = { name: "disable", - description: "Disables daemon-mode operation of the Zowe CLI.", + summary: "Disable daemon-mode operation of the Zowe CLI", + description: "Disable daemon-mode operation of the Zowe CLI.", type: "command", handler: __dirname + "/Disable.handler", examples: [ diff --git a/packages/cli/src/daemon/enable/Enable.definition.ts b/packages/cli/src/daemon/enable/Enable.definition.ts index 17e7ba337a..2028496f9c 100644 --- a/packages/cli/src/daemon/enable/Enable.definition.ts +++ b/packages/cli/src/daemon/enable/Enable.definition.ts @@ -13,7 +13,8 @@ import { ICommandDefinition } from "@zowe/imperative"; export const EnableCommand: ICommandDefinition = { name: "enable", - description: "Enables daemon-mode operation of the Zowe CLI. " + + summary: "Enable daemon-mode operation of the Zowe CLI", + description: "Enable daemon-mode operation of the Zowe CLI. " + "You only need to run the enable command once after each " + "new installation of the Zowe CLI. Afterwards, any zowe command " + "will automatically start a daemon as needed.", diff --git a/packages/cli/src/daemon/restart/Restart.definition.ts b/packages/cli/src/daemon/restart/Restart.definition.ts index 9d46676e6d..b4f07aeca7 100644 --- a/packages/cli/src/daemon/restart/Restart.definition.ts +++ b/packages/cli/src/daemon/restart/Restart.definition.ts @@ -13,6 +13,7 @@ import { ICommandDefinition } from "@zowe/imperative"; export const RestartCommand: ICommandDefinition = { name: "restart", + summary: "Restart the Zowe CLI daemon", description: "Restart the Zowe CLI daemon.", type: "command", handler: __dirname + "/Restart.handler", diff --git a/packages/cli/src/provisioning/delete/Delete.definition.ts b/packages/cli/src/provisioning/delete/Delete.definition.ts index 8cb32b6589..77a645cbe4 100644 --- a/packages/cli/src/provisioning/delete/Delete.definition.ts +++ b/packages/cli/src/provisioning/delete/Delete.definition.ts @@ -17,7 +17,7 @@ export const DeleteCommand: ICommandDefinition = { name: "delete", aliases: ["del"], type: "group", - summary: "Delete instance.", + summary: "Delete instance", description: "Deletes instance previously provisioned with z/OSMF cloud provisioning services.", children: [DeleteInstanceDefinition] }; diff --git a/packages/cli/src/provisioning/delete/instance/DeleteInstance.definition.ts b/packages/cli/src/provisioning/delete/instance/DeleteInstance.definition.ts index 89ee90a04d..3a731517e8 100644 --- a/packages/cli/src/provisioning/delete/instance/DeleteInstance.definition.ts +++ b/packages/cli/src/provisioning/delete/instance/DeleteInstance.definition.ts @@ -15,7 +15,7 @@ export const DeleteInstanceDefinition: ICommandDefinition = { name: "instance", aliases: ["i"], type: "command", - summary: "Deletes instance.", + summary: "Deletes instance", description: "Deletes selected deprovisioned instance.", handler: __dirname + "/DeleteInstance.handler", profile: { diff --git a/packages/cli/src/provisioning/list/catalogTemplates/CatalogTemplates.definition.ts b/packages/cli/src/provisioning/list/catalogTemplates/CatalogTemplates.definition.ts index 19d99b7943..6e0d6589d7 100644 --- a/packages/cli/src/provisioning/list/catalogTemplates/CatalogTemplates.definition.ts +++ b/packages/cli/src/provisioning/list/catalogTemplates/CatalogTemplates.definition.ts @@ -16,7 +16,7 @@ export const catalogTemplates: ICommandDefinition = { name: "catalog-templates", aliases: ["ct"], type: "command", - summary: "List z/OSMF published catalog templates.", + summary: "List z/OSMF published catalog templates", description: "Lists the z/OSMF service catalog published templates.", handler: path.join(__dirname, "/CatalogTemplates.handler"), profile: { diff --git a/packages/cli/src/provisioning/list/instanceInfo/InstanceInfo.definition.ts b/packages/cli/src/provisioning/list/instanceInfo/InstanceInfo.definition.ts index a518dd954a..a5a1a92d4d 100644 --- a/packages/cli/src/provisioning/list/instanceInfo/InstanceInfo.definition.ts +++ b/packages/cli/src/provisioning/list/instanceInfo/InstanceInfo.definition.ts @@ -16,7 +16,7 @@ export const instanceInfo: ICommandDefinition = { name: "instance-info", aliases: ["ii"], type: "command", - summary: "List Provisioned Instance Details.", + summary: "List Provisioned Instance Details", description: "List details about an instance provisioned with z/OSMF.", handler: path.join(__dirname, "/InstanceInfo.handler"), profile: { diff --git a/packages/cli/src/provisioning/list/instanceVariables/InstanceVariables.definition.ts b/packages/cli/src/provisioning/list/instanceVariables/InstanceVariables.definition.ts index 1bcaec3e2a..9627c0229f 100644 --- a/packages/cli/src/provisioning/list/instanceVariables/InstanceVariables.definition.ts +++ b/packages/cli/src/provisioning/list/instanceVariables/InstanceVariables.definition.ts @@ -16,7 +16,7 @@ export const instanceVariables: ICommandDefinition = { name: "instance-variables", aliases: ["iv"], type: "command", - summary: "List Instance Variables and Values.", + summary: "List Instance Variables and Values", description: "List a set of variables and their values for a given name.", handler: path.join(__dirname, "/InstanceVariables.handler"), profile: { diff --git a/packages/cli/src/provisioning/list/registry/RegistryInstances.definition.ts b/packages/cli/src/provisioning/list/registry/RegistryInstances.definition.ts index 5a689c46d5..03b7f7a5db 100644 --- a/packages/cli/src/provisioning/list/registry/RegistryInstances.definition.ts +++ b/packages/cli/src/provisioning/list/registry/RegistryInstances.definition.ts @@ -16,7 +16,7 @@ export const registryInstances: ICommandDefinition = { name: "registry-instances", aliases: ["ri"], type: "command", - summary: "List provisioned instances.", + summary: "List provisioned instances", description: "List the provisioned instances from the z/OSMF software registry.", handler: path.join(__dirname, "/RegistryInstances.handler"), profile: { diff --git a/packages/cli/src/provisioning/list/templateInfo/TemplateInfo.definition.ts b/packages/cli/src/provisioning/list/templateInfo/TemplateInfo.definition.ts index 05d499dcc1..abbd546d10 100644 --- a/packages/cli/src/provisioning/list/templateInfo/TemplateInfo.definition.ts +++ b/packages/cli/src/provisioning/list/templateInfo/TemplateInfo.definition.ts @@ -16,7 +16,7 @@ export const templateInfo: ICommandDefinition = { name: "template-info", aliases: ["ti"], type: "command", - summary: "List Published Template Details.", + summary: "List Published Template Details", description: "List details about a template published with z/OSMF Cloud Provisioning.", handler: path.join(__dirname, "/TemplateInfo.handler"), profile: { diff --git a/packages/cli/src/provisioning/perform/Perform.definition.ts b/packages/cli/src/provisioning/perform/Perform.definition.ts index dfbb3f13ac..1b68c93da3 100644 --- a/packages/cli/src/provisioning/perform/Perform.definition.ts +++ b/packages/cli/src/provisioning/perform/Perform.definition.ts @@ -17,7 +17,7 @@ export const PerformCommand: ICommandDefinition = { name: "perform", aliases: ["perf"], type: "group", - summary: "Perform instance actions.", + summary: "Perform instance actions", description: "Perform actions against instances provisioned with z/OSMF.", children: [ActionDefinition] }; diff --git a/packages/cli/src/provisioning/perform/action/Action.definition.ts b/packages/cli/src/provisioning/perform/action/Action.definition.ts index 307674eca0..0134cb8ff5 100644 --- a/packages/cli/src/provisioning/perform/action/Action.definition.ts +++ b/packages/cli/src/provisioning/perform/action/Action.definition.ts @@ -15,7 +15,7 @@ export const ActionDefinition: ICommandDefinition = { name: "action", aliases: ["act"], type: "command", - summary: "Perform instance actions.", + summary: "Perform instance actions", description: "Perform actions on instances previously provisioned with z/OSMF cloud\n" + " provisioning services. To view the list of provisioned instances, use the\n" + " \"zowe provisioning list registry-instances\" command. Once you have\n" + diff --git a/packages/cli/src/provisioning/provision/Provision.definition.ts b/packages/cli/src/provisioning/provision/Provision.definition.ts index 14dab7119f..fd9768a806 100644 --- a/packages/cli/src/provisioning/provision/Provision.definition.ts +++ b/packages/cli/src/provisioning/provision/Provision.definition.ts @@ -17,7 +17,7 @@ export const ProvisionCommand: ICommandDefinition = { name: "provision", aliases: ["prov"], type: "group", - summary: "Provision published software service templates.", + summary: "Provision published software service templates", description: "Using z/OSMF cloud provisioning services provision available templates.", children: [TemplateDefinition] }; diff --git a/packages/cli/src/provisioning/provision/template/Template.definition.ts b/packages/cli/src/provisioning/provision/template/Template.definition.ts index 05e65bea33..962623717d 100644 --- a/packages/cli/src/provisioning/provision/template/Template.definition.ts +++ b/packages/cli/src/provisioning/provision/template/Template.definition.ts @@ -16,7 +16,7 @@ export const TemplateDefinition: ICommandDefinition = { name: "template", aliases: ["tem"], type: "command", - summary: "Provision a published software service template.", + summary: "Provision a published software service template", description: "Using z/OSMF cloud provisioning services, provision available templates.\n" + "You can view available templates using the " + Constants.BINARY_NAME + " provisioning list " + "catalog-templates command.", diff --git a/packages/cli/src/workflows/archive/Archive.definition.ts b/packages/cli/src/workflows/archive/Archive.definition.ts index 62064ace2d..ce29afcb3d 100644 --- a/packages/cli/src/workflows/archive/Archive.definition.ts +++ b/packages/cli/src/workflows/archive/Archive.definition.ts @@ -21,6 +21,7 @@ import { Workflow } from "./workflow/Archive.workflow.definition"; export const ArchiveDefinition: ICommandDefinition = { name: "archive", type: "group", + summary: "Archive workflow instance in z/OSMF", description: "Archive workflow instance in z/OSMF.", children: [ Workflow diff --git a/packages/cli/src/workflows/create/Create.common.options.ts b/packages/cli/src/workflows/create/Create.common.options.ts index 521d877599..4d59718e4b 100644 --- a/packages/cli/src/workflows/create/Create.common.options.ts +++ b/packages/cli/src/workflows/create/Create.common.options.ts @@ -17,38 +17,38 @@ import { ICommandOptionDefinition } from "@zowe/imperative"; export const CreateCommonOptions: { [key: string]: ICommandOptionDefinition } = { /** - * Data set containing workflow definiton option. + * Data set containing workflow definition option. * @type {ICommandOptionDefinition} */ dataSet: { name: "data-set", aliases: ["ds"], type: "string", - description: "Data set that contains a workflow definiton.", + description: "Data set that contains a workflow definition.", required: true }, /** - * Uss file containing workflow definiton option. + * Uss file containing workflow definition option. * @type {ICommandOptionDefinition} */ ussFile: { name: "uss-file", aliases: ["uf"], type: "string", - description: "Uss file that contains workflow definiton.", + description: "USS file that contains workflow definition.", required: true }, /** - * Local file containing workflow definiton option. + * Local file containing workflow definition option. * @type {ICommandOptionDefinition} */ localFile: { name: "local-file", aliases: ["lf"], type: "string", - description: "Local file that contains workflow definiton.", + description: "Local file that contains workflow definition.", required: true }, @@ -162,7 +162,7 @@ export const CreateCommonOptions: { [key: string]: ICommandOptionDefinition } = remoteDirectory: { name: "remote-directory", aliases: ["rd"], - description: "The remote uss directory where the files are to be uploaded. The directory has to exist", + description: "The remote USS directory where the files are to be uploaded. The directory has to exist.", type: "string", required: false }, diff --git a/packages/cli/src/workflows/create/Create.definition.ts b/packages/cli/src/workflows/create/Create.definition.ts index c737718e0d..c38198a995 100644 --- a/packages/cli/src/workflows/create/Create.definition.ts +++ b/packages/cli/src/workflows/create/Create.definition.ts @@ -25,6 +25,7 @@ export const CreateDefinition: ICommandDefinition = { name: "create", aliases: ["cre"], type: "group", + summary: "Create a z/OSMF workflow on a z/OS system", description: "Create a z/OSMF workflow on a z/OS system.", children: [ DataSet, diff --git a/packages/cli/src/workflows/create/dataset/Dataset.definition.ts b/packages/cli/src/workflows/create/dataset/Dataset.definition.ts index d3667da6e9..d8e95d0a8d 100644 --- a/packages/cli/src/workflows/create/dataset/Dataset.definition.ts +++ b/packages/cli/src/workflows/create/dataset/Dataset.definition.ts @@ -22,7 +22,8 @@ import { join } from "path"; export const DataSet: ICommandDefinition = { name: "workflow-from-data-set", aliases: ["wfds"], - description: "Create a z/OSMF workflow on a z/OS system using a Data set", + summary: "Create a z/OSMF workflow on a z/OS system using a data set", + description: "Create a z/OSMF workflow on a z/OS system using a data set.", type: "command", handler: join(__dirname, "../Create.common.handler"), profile: { diff --git a/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts b/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts index 71815c6e82..d4411afb68 100644 --- a/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts +++ b/packages/cli/src/workflows/create/localfile/LocalFile.definition.ts @@ -23,7 +23,8 @@ import { join } from "path"; export const LocalFile: ICommandDefinition = { name: "workflow-from-local-file", aliases: ["wflf"], - description: "Create a z/OSMF workflow on a z/OS system using a Local file", + summary: "Create a z/OSMF workflow on a z/OS system using a local file", + description: "Create a z/OSMF workflow on a z/OS system using a local file.", type: "command", handler: join(__dirname, "../Create.common.handler"), profile: { diff --git a/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts b/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts index f3b60e9cd0..30f2599427 100644 --- a/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts +++ b/packages/cli/src/workflows/create/ussfile/UssFile.definition.ts @@ -22,7 +22,8 @@ import { join } from "path"; export const UssFile: ICommandDefinition = { name: "workflow-from-uss-file", aliases: ["wfuf"], - description: "Create a workflow instance in z/OSMF using a USS file", + summary: "Create a workflow instance in z/OSMF using a USS file", + description: "Create a workflow instance in z/OSMF using a USS file.", type: "command", handler: join(__dirname, "../Create.common.handler"), profile: { diff --git a/packages/cli/src/workflows/delete/Delete.definition.ts b/packages/cli/src/workflows/delete/Delete.definition.ts index 1e90e955aa..a7288bd55a 100644 --- a/packages/cli/src/workflows/delete/Delete.definition.ts +++ b/packages/cli/src/workflows/delete/Delete.definition.ts @@ -24,6 +24,7 @@ export const DeleteDefinition: ICommandDefinition = { name: "delete", aliases: ["del"], type: "group", + summary: "Delete an active workflow or an archived workflow from z/OSMF", description: "Delete an active workflow or an archived workflow from z/OSMF.", children: [ DeleteActiveWorkflow, diff --git a/packages/cli/src/workflows/delete/deleteActiveWorkflow/DeleteActiveWorkflow.definition.ts b/packages/cli/src/workflows/delete/deleteActiveWorkflow/DeleteActiveWorkflow.definition.ts index 07392f7fcd..af17d65326 100644 --- a/packages/cli/src/workflows/delete/deleteActiveWorkflow/DeleteActiveWorkflow.definition.ts +++ b/packages/cli/src/workflows/delete/deleteActiveWorkflow/DeleteActiveWorkflow.definition.ts @@ -23,7 +23,8 @@ import { DeleteWorkflowOptions } from "../deleteActiveWorkflow/DeleteActiveWorkf export const DeleteActiveWorkflow: ICommandDefinition = { name: "active-workflow", aliases: ["aw"], - description: "Delete an active workflow instance in z/OSMF", + summary: "Delete an active workflow instance in z/OSMF", + description: "Delete an active workflow instance in z/OSMF.", type: "command", handler: join(__dirname, "../Delete.common.handler"), profile: { diff --git a/packages/cli/src/workflows/delete/deleteArchivedWorkflow/DeleteArchivedWorkflow.definition.ts b/packages/cli/src/workflows/delete/deleteArchivedWorkflow/DeleteArchivedWorkflow.definition.ts index c53a8b2842..70ee9834d3 100644 --- a/packages/cli/src/workflows/delete/deleteArchivedWorkflow/DeleteArchivedWorkflow.definition.ts +++ b/packages/cli/src/workflows/delete/deleteArchivedWorkflow/DeleteArchivedWorkflow.definition.ts @@ -23,7 +23,8 @@ import { DeleteArchivedWorkflowOptions } from "../deleteArchivedWorkflow/DeleteA export const DeleteArchivedWorkflow: ICommandDefinition = { name: "archived-workflow", aliases: ["arw"], - description: "Delete an archived workflow from z/OSMF", + summary: "Delete an archived workflow from z/OSMF", + description: "Delete an archived workflow from z/OSMF.", type: "command", handler: join(__dirname, "../Delete.archived.common.handler"), profile: { diff --git a/packages/cli/src/workflows/list/List.definition.ts b/packages/cli/src/workflows/list/List.definition.ts index 77ca57d553..6c35a0fdb5 100644 --- a/packages/cli/src/workflows/list/List.definition.ts +++ b/packages/cli/src/workflows/list/List.definition.ts @@ -26,6 +26,7 @@ export const ListDefinition: ICommandDefinition = { name: "list", aliases: ["ls"], type: "group", + summary: "List the z/OSMF workflows for a system or a sysplex with filter options", description: "List the z/OSMF workflows for a system or a sysplex with filter options.", children: [ ActiveWorkflows, diff --git a/packages/cli/src/workflows/list/activeWorkflowDetails/ActiveWorkflowDetails.definition.ts b/packages/cli/src/workflows/list/activeWorkflowDetails/ActiveWorkflowDetails.definition.ts index d16c4109c5..cd7217b466 100644 --- a/packages/cli/src/workflows/list/activeWorkflowDetails/ActiveWorkflowDetails.definition.ts +++ b/packages/cli/src/workflows/list/activeWorkflowDetails/ActiveWorkflowDetails.definition.ts @@ -22,7 +22,8 @@ import { join } from "path"; export const ActiveWorkflowDetails: ICommandDefinition = { name: "active-workflow-details", aliases: ["awd"], - description: "Get the details of an active z/OSMF workflow", + summary: "Get the details of an active z/OSMF workflow", + description: "Get the details of an active z/OSMF workflow.", type: "command", handler: join(__dirname, "./ActiveWorkflowDetails.handler"), profile: { diff --git a/packages/cli/src/workflows/list/activeWorkflows/ActiveWorkflows.definition.ts b/packages/cli/src/workflows/list/activeWorkflows/ActiveWorkflows.definition.ts index 6e8aa6c28c..e8f3abf095 100644 --- a/packages/cli/src/workflows/list/activeWorkflows/ActiveWorkflows.definition.ts +++ b/packages/cli/src/workflows/list/activeWorkflows/ActiveWorkflows.definition.ts @@ -23,10 +23,10 @@ import { join } from "path"; export const ActiveWorkflows: ICommandDefinition = { name: "active-workflows", aliases: ["aw"], - summary: "List active workflow instance(s) in z/OSMF.", + summary: "List active workflow instance(s) in z/OSMF", description: "List active workflow instance(s) in z/OSMF.\n" + "Multiple filters can be used together.\n" + - "Omitting all options will list all workflows on the sysplex", + "Omitting all options will list all workflows on the sysplex.", type: "command", handler: join(__dirname, "ActiveWorkflows.handler"), profile: { diff --git a/packages/cli/src/workflows/list/archivedWorkflows/ArchivedWorkflows.definition.ts b/packages/cli/src/workflows/list/archivedWorkflows/ArchivedWorkflows.definition.ts index 3eef2605f0..a1cb40b173 100644 --- a/packages/cli/src/workflows/list/archivedWorkflows/ArchivedWorkflows.definition.ts +++ b/packages/cli/src/workflows/list/archivedWorkflows/ArchivedWorkflows.definition.ts @@ -21,7 +21,7 @@ import { join } from "path"; export const ArchivedWorkflows: ICommandDefinition = { name: "archived-workflows", aliases: ["arw"], - summary: "List all archived workflows for a system.", + summary: "List all archived workflows for a system", description: "List the archived z/OSMF workflows for a system or sysplex.", type: "command", handler: join(__dirname, "ArchivedWorkflows.handler"), diff --git a/packages/cli/src/workflows/list/retrieveWorkflowDefinition/RetrieveWorkflowDefinition.definition.ts b/packages/cli/src/workflows/list/retrieveWorkflowDefinition/RetrieveWorkflowDefinition.definition.ts index f58c89135f..a0f9961de8 100644 --- a/packages/cli/src/workflows/list/retrieveWorkflowDefinition/RetrieveWorkflowDefinition.definition.ts +++ b/packages/cli/src/workflows/list/retrieveWorkflowDefinition/RetrieveWorkflowDefinition.definition.ts @@ -22,6 +22,7 @@ import { join } from "path"; export const RetrieveWorkflowDefinition: ICommandDefinition = { name: "definition-file-details", aliases: ["dfd"], + summary: "Retrieve the contents of a z/OSMF workflow definition from a z/OS system", description: "Retrieve the contents of a z/OSMF workflow definition from a z/OS system.", type: "command", handler: join(__dirname, "./RetrieveWorkflowDefinition.handler"), diff --git a/packages/cli/src/workflows/start/Start.definition.ts b/packages/cli/src/workflows/start/Start.definition.ts index 9de5c35a42..f082ee65a1 100644 --- a/packages/cli/src/workflows/start/Start.definition.ts +++ b/packages/cli/src/workflows/start/Start.definition.ts @@ -24,6 +24,7 @@ export const StartDefinition: ICommandDefinition = { name: "start", aliases: ["sta"], type: "group", + summary: "Start a z/OSMF workflow on a z/OS system", description: "Start a z/OSMF workflow on a z/OS system.", children: [ WorkflowFull, diff --git a/packages/cli/src/workflows/start/workflowFull/WorkflowFull.definition.ts b/packages/cli/src/workflows/start/workflowFull/WorkflowFull.definition.ts index 31b0b140de..4f502241b3 100644 --- a/packages/cli/src/workflows/start/workflowFull/WorkflowFull.definition.ts +++ b/packages/cli/src/workflows/start/workflowFull/WorkflowFull.definition.ts @@ -23,6 +23,7 @@ import { StartCommonOptions } from "../Start.common.options"; export const WorkflowFull: ICommandDefinition = { name: "workflow-full", aliases: ["wf"], + summary: "Will run workflow from the beginning to the end or to the first manual step", description: "Will run workflow from the beginning to the end or to the first manual step.", type: "command", handler: join(__dirname, "./WorkflowFull.handler"), diff --git a/packages/cli/src/workflows/start/workflowStep/WorkflowStep.definition.ts b/packages/cli/src/workflows/start/workflowStep/WorkflowStep.definition.ts index dbd6aedbd0..d6d8ef1887 100644 --- a/packages/cli/src/workflows/start/workflowStep/WorkflowStep.definition.ts +++ b/packages/cli/src/workflows/start/workflowStep/WorkflowStep.definition.ts @@ -23,6 +23,7 @@ import { StartCommonOptions } from "../Start.common.options"; export const WorkflowStep: ICommandDefinition = { name: "workflow-step", aliases: ["ws"], + summary: "Will run given step of workflow instance plus following steps if specified by --perform-following-steps option", description: "Will run given step of workflow instance plus following steps if specified by --perform-following-steps option.", type: "command", handler: join(__dirname, "./WorkflowStep.handler"), diff --git a/packages/cli/src/zosfiles/-strings-/en.ts b/packages/cli/src/zosfiles/-strings-/en.ts index 2552a946be..17521e840e 100644 --- a/packages/cli/src/zosfiles/-strings-/en.ts +++ b/packages/cli/src/zosfiles/-strings-/en.ts @@ -20,31 +20,36 @@ export default { WITH_VALUE: "with value" }, CREATE: { + SUMMARY: "Create data sets", DESCRIPTION: "Create data sets.", ACTIONS: { DATA_SET_BINARY: { - DESCRIPTION: "Create executable data sets", + SUMMARY: "Create executable data sets", + DESCRIPTION: "Create executable data sets.", EXAMPLES: { EX1: "Create an empty binary partitioned data set (PDS) with default parameters", EX2: "Create an empty binary PDSE using data set type LIBRARY" } }, DATA_SET_CLASSIC: { - DESCRIPTION: "Create classic data sets (JCL, HLASM, CBL, etc...)", + SUMMARY: "Create classic data sets (JCL, HLASM, CBL, etc...)", + DESCRIPTION: "Create classic data sets (JCL, HLASM, CBL, etc...).", EXAMPLES: { EX1: "Create an empty z/OS 'classic' PDS with default parameters", EX2: `Create an empty z/OS 'classic' PDSE using data set type LIBRARY` } }, DATA_SET_C: { - DESCRIPTION: "Create data sets for C code programming", + SUMMARY: "Create data sets for C code programming", + DESCRIPTION: "Create data sets for C code programming.", EXAMPLES: { EX1: "Create an empty C code PDS with default parameters", EX2: "Create an empty C code PDSE using data set type LIBRARY" } }, DATA_SET_LIKE: { - DESCRIPTION: "Create data sets based on the properties of an existing data set", + SUMMARY: "Create data sets based on the properties of an existing data set", + DESCRIPTION: "Create data sets based on the properties of an existing data set.", EXAMPLES: { EX1: "Create a data set with default parameters and like flag", EX2: "Create a data set with default parameters and like flag and lrecl flag", @@ -52,22 +57,25 @@ export default { } }, DATA_SET_PARTITIONED: { - DESCRIPTION: "Create partitioned data sets (PDS)", + SUMMARY: "Create partitioned data sets (PDS)", + DESCRIPTION: "Create partitioned data sets (PDS).", EXAMPLES: { EX1: "Create an empty PDS with default parameters", EX2: "Create an empty PDSE using data set type LIBRARY" } }, DATA_SET_SEQUENTIAL: { - DESCRIPTION: "Create physical sequential data sets (PS)", + SUMMARY: "Create physical sequential data sets (PS)", + DESCRIPTION: "Create physical sequential data sets (PS).", EXAMPLES: { EX1: "Create an empty physical sequential data set with default parameters" } }, VSAM: { - DESCRIPTION: "Create a VSAM cluster", + SUMMARY: "Create a VSAM cluster", + DESCRIPTION: "Create a VSAM cluster.", POSITIONALS: { - DATASETNAME: "The name of the dataset in which to create a VSAM cluster" + DATASETNAME: "The name of the data set in which to create a VSAM cluster" }, OPTIONS: { RETAINFOR: "The number of days that the VSAM cluster will be retained on the system. You can delete the cluster at any " + @@ -176,16 +184,18 @@ export default { } }, COPY: { + SUMMARY: "Copy a data set", DESCRIPTION: "Copy a data set.", ACTIONS: { DATA_SET: { - DESCRIPTION: "Copy a data set to another data set", + SUMMARY: "Copy a data set to another data set", + DESCRIPTION: "Copy a data set to another data set.", POSITIONALS: { FROMDSNAME: "The name of the data set that you want to copy from", TODSNAME: "The name of the data set that you want to copy to (data set must be preallocated)" }, OPTIONS: { - REPLACE: "Specify this option as true if you wish to replace like-named members in the target dataset" + REPLACE: "Specify this option as true if you wish to replace like-named members in the target data set" }, EXAMPLES: { EX1: "Copy the data set named 'USER.FROM.SET' to the data set named 'USER.TO.SET'", @@ -196,21 +206,22 @@ export default { } }, DATA_SET_CROSS_LPAR: { - DESCRIPTION: "Copy a data set to another data set on a specified LPAR", + SUMMARY: "Copy a data set to another data set on a specified LPAR", + DESCRIPTION: "Copy a data set to another data set on a specified LPAR.", POSITIONALS: { FROMDSNAME: "The name of the data set that you want to copy from", - TODSNAME: "The name of the data set that you want to copy to. If the dataset does not " + + TODSNAME: "The name of the data set that you want to copy to. If the data set does not " + "exist it will be allocated automatically" }, OPTIONS: { - REPLACE: "Specify this option as true if you wish to replace the target dataset if it already exists", + REPLACE: "Specify this option as true if you wish to replace the target data set if it already exists.", TARGETHOST: "The target z/OSMF server host name.", TARGETPORT: "The target z/OSMF server port.", TARGETUSER: "The target z/OSMF user name, which can be the same as your TSO login.", TARGETPASS: "The target z/OSMF password, which can be the same as your TSO password.", TARGETTOKENVAL: "The type of token to get and use for the API for the target system.", TARGETTOKENTYPE: "The value of the token to pass to the API for the target system.", - TARGETPROFILE: "The name of a z/OSMF profile to load for the target host. ", + TARGETPROFILE: "The name of a z/OSMF profile to load for the target host.", TARGETVOLSER: "The volume serial (VOLSER) on which you want the target data set to be placed.", TARGETMGTCLS: "The SMS management class to use for the allocation of the target data set.", TARGETDATACLS: "The SMS data class to use for the allocation of the target data set.", @@ -228,10 +239,12 @@ export default { } }, DELETE: { + SUMMARY: "Delete a data set or Unix System Services file", DESCRIPTION: "Delete a data set or Unix System Services file.", ACTIONS: { DATA_SET: { - DESCRIPTION: "Delete a data set or data set member permanently", + SUMMARY: "Delete a data set or data set member permanently", + DESCRIPTION: "Delete a data set or data set member permanently.", POSITIONALS: { DSNAME: "The name of the data set that you want to delete" }, @@ -246,6 +259,7 @@ export default { } }, MIGRATED_DATA_SET: { + SUMMARY: "Delete migrated data sets", DESCRIPTION: "Delete migrated data sets.", POSITIONALS: { DATASETNAME: "The name of the migrated data set you want to delete." @@ -260,7 +274,8 @@ export default { } }, VSAM: { - DESCRIPTION: "Delete a VSAM cluster permanently", + SUMMARY: "Delete a VSAM cluster permanently", + DESCRIPTION: "Delete a VSAM cluster permanently.", POSITIONALS: { DSNAME: "The name of the VSAM cluster that you want to delete" }, @@ -278,7 +293,8 @@ export default { } }, USS: { - DESCRIPTION: "Delete a Unix Systems Services (USS) File or directory permanently", + SUMMARY: "Delete a Unix Systems Services (USS) file or directory permanently", + DESCRIPTION: "Delete a Unix Systems Services (USS) file or directory permanently.", POSITIONALS: { FILENAME: "The name of the file or directory that you want to delete" }, @@ -313,7 +329,7 @@ export default { ACTIONS: { ALL_MEMBERS: { SUMMARY: "Download all members from a pds", - DESCRIPTION: "Download all members from a partitioned data set to a local folder", + DESCRIPTION: "Download all members from a partitioned data set to a local folder.", POSITIONALS: { DATASETNAME: "The name of the data set from which you want to download members" }, @@ -324,7 +340,7 @@ export default { }, DATA_SET: { SUMMARY: "Download content from a z/OS data set", - DESCRIPTION: "Download content from a z/OS data set to a local file", + DESCRIPTION: "Download content from a z/OS data set to a local file.", POSITIONALS: { DATASETNAME: "The name of the data set that you want to download" }, @@ -334,7 +350,7 @@ export default { }, USS_FILE: { SUMMARY: "Download content from a USS file", - DESCRIPTION: "Download content from a USS file to a local file on your PC", + DESCRIPTION: "Download content from a USS file to a local file on your PC.", POSITIONALS: { USSFILENAME: "The name of the USS file you want to download" }, @@ -345,7 +361,7 @@ export default { }, USS_DIR: { SUMMARY: "Download content from a USS directory", - DESCRIPTION: "Download content from a USS directory to a local directory on your PC", + DESCRIPTION: "Download content from a USS directory to a local directory on your PC.", POSITIONALS: { USSDIRNAME: "The name of the USS directory you want to download" }, @@ -381,7 +397,7 @@ export default { } }, OPTIONS: { - ATTRIBUTES: "Path of an attributes file to control how files are downloaded", + ATTRIBUTES: "Path of an attributes file to control how files are downloaded.", VOLUME: "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.", BINARY: "Download the file content in binary mode, which means that no data conversion is performed. The data transfer process " + @@ -391,7 +407,7 @@ export default { " Conflicts with binary.", ENCODING: "Download the file content with encoding mode, which means that data conversion is performed using the file encoding " + "specified.", - FAIL_FAST: "Set this option to false to continue downloading dataset members if one or more fail.", + FAIL_FAST: "Set this option to false to continue downloading data set members if one or more fail.", FAIL_FAST_USS: "Set this option to false to continue downloading USS files if one or more fail.", FILE: "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.", @@ -423,9 +439,9 @@ export default { "The maximum number of TSO address spaces have been created. When you specify 0, " + Constants.DISPLAY_NAME + " attempts to download all files at once" + " without a maximum number of concurrent requests. ", - PRESERVE_ORIGINAL_LETTER_CASE: "Specifies if the automatically generated directories and files use the original letter case", - INCLUDE_HIDDEN: "Include hidden files and folders that have names beginning with a dot", - OVERWRITE: "Overwrite files that already exist in your local environment" + PRESERVE_ORIGINAL_LETTER_CASE: "Specifies if the automatically generated directories and files use the original letter case.", + INCLUDE_HIDDEN: "Include hidden files and folders that have names beginning with a dot.", + OVERWRITE: "Overwrite files that already exist in your local environment." } }, INVOKE: { @@ -477,7 +493,7 @@ export default { }, DATA_SET: { SUMMARY: "List data sets", - DESCRIPTION: "List data sets that match a pattern in the data set name", + DESCRIPTION: "List data sets that match a pattern in the data set name.", POSITIONALS: { DATASETNAME: "The name or pattern of the data set that you want to list" }, @@ -491,7 +507,7 @@ export default { }, USS_FILE: { SUMMARY: "List USS files", - DESCRIPTION: "List USS files and directories in a UNIX file path", + DESCRIPTION: "List USS files and directories in a UNIX file path.", POSITIONALS: { PATH: "The directory containing the files and directories to be listed" }, @@ -587,10 +603,12 @@ export default { } }, UPLOAD: { + SUMMARY: "Upload the contents of a file to data sets", DESCRIPTION: "Upload the contents of a file to data sets.", ACTIONS: { DIR_TO_PDS: { - DESCRIPTION: "Upload files from a local directory to a partitioned data set (PDS)", + SUMMARY: "Upload files from a local directory to a partitioned data set (PDS)", + DESCRIPTION: "Upload files from a local directory to a partitioned data set (PDS).", POSITIONALS: { INPUTDIR: "The path for a local directory that you want to upload to a PDS", DATASETNAME: "The name of the partitioned data set to which you want to upload the files" @@ -601,7 +619,8 @@ export default { } }, FILE_TO_DATA_SET: { - DESCRIPTION: "Upload the contents of a file to a z/OS data set", + SUMMARY: "Upload the contents of a file to a z/OS data set", + DESCRIPTION: "Upload the contents of a file to a z/OS data set.", POSITIONALS: { INPUTFILE: "The local file that you want to upload to a data set", DATASETNAME: "The name of the data set to which you want to upload the file" @@ -613,7 +632,8 @@ export default { } }, STDIN_TO_DATA_SET: { - DESCRIPTION: "Upload the content of a stdin to a z/OS data set", + SUMMARY: "Upload the content of a stdin to a z/OS data set", + DESCRIPTION: "Upload the content of a stdin to a z/OS data set.", POSITIONALS: { DATASETNAME: "The name of the data set to which you want to upload data" }, @@ -624,7 +644,8 @@ export default { } }, FILE_TO_USS: { - DESCRIPTION: "Upload content to a USS file from local file", + SUMMARY: "Upload content to a USS file from local file", + DESCRIPTION: "Upload content to a USS file from local file.", POSITIONALS: { INPUTFILE: "The local file that you want to upload to a USS file", USSFILENAME: "The name of the USS file to which you want to upload the file" @@ -701,7 +722,7 @@ export default { "All files matching specified file names will be uploaded in ASCII mode. " + "If a .zosattributes file (or equivalent file specified via --attributes) is present, " + "--ascii-files will be ignored.", - ATTRIBUTES: "Path of an attributes file to control how files are uploaded", + ATTRIBUTES: "Path of an attributes file to control how files are uploaded.", MAX_CONCURRENT_REQUESTS: "Specifies the maximum number of concurrent z/OSMF 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 " + @@ -710,7 +731,7 @@ export default { "The maximum number of TSO address spaces have been created. When you specify 0, " + Constants.DISPLAY_NAME + " attempts to upload all members at once" + " without a maximum number of concurrent requests. ", - INCLUDE_HIDDEN: "Include hidden files and folders that have names beginning with a dot" + INCLUDE_HIDDEN: "Include hidden files and folders that have names beginning with a dot." } }, VIEW: { @@ -790,12 +811,12 @@ export default { } }, COMPARE: { - SUMMARY: "Compare the contents of a two data set members", - DESCRIPTION: "Compare the contents of a two data set members on your terminal (stdout).", + SUMMARY: "Compare the contents of z/OS data sets or USS files", + DESCRIPTION: "Compare the contents of z/OS data sets or USS files in your terminal (stdout).", ACTIONS: { DATA_SET: { - SUMMARY: "Compare content of two z/OS data sets", - DESCRIPTION: "Compare content of two z/OS data sets on your terminal (stdout).", + SUMMARY: "Compare the contents of two z/OS data sets", + DESCRIPTION: "Compare the contents of two z/OS data sets in your terminal (stdout).", POSITIONALS: { DATASETNAME1: "The name of the first data set you want to compare.", DATASETNAME2: "The name of the second data set you want to compare." @@ -806,73 +827,73 @@ export default { } }, LOCAL_FILE_DATA_SET: { - SUMMARY: "Compare content of a local file and a z/os dataset", - DESCRIPTION: "Compare content of a local file and a z/os dataset on your terminal (stdout).", + SUMMARY: "Compare the contents of a local file and a z/OS data set", + DESCRIPTION: "Compare the contents of a local file and a z/OS data set in your terminal (stdout).", POSITIONALS: { - LOCALFILEPATH: "The path of the local file you want to compare.", + LOCALFILEPATH: "The path of the local file you want to compare.", DATASETNAME: "The name of the data set you want to compare." }, EXAMPLES: { EX1: `Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)"`, - EX2: `Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)"` + + EX2: `Compare the contents of the local file and the data set member "./a.txt" and "sys1.samplib(antxtso)" ` + `without sequence numbers` } }, USS_FILE: { - SUMMARY: "Compare content of a local file and a z/os uss files", - DESCRIPTION: "Compare the contents of a two uss files on your terminal (stdout). browser.", + SUMMARY: "Compare the contents of two z/OS USS files", + DESCRIPTION: "Compare the contents of two z/OS USS files in your terminal (stdout).", POSITIONALS: { - USSFILEPATH1: "The path of the first uss file you want to compare.", - USSFILEPATH2: "The path of the second uss file you want to compare." + USSFILEPATH1: "The path of the first USS file you want to compare.", + USSFILEPATH2: "The path of the second USS file you want to compare." }, EXAMPLES: { - EX1: `Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt"`, - EX2: `Compare the contents of the uss file "/u/user/test.txt" and "/u/user/test.txt" without sequence numbers` + EX1: `Compare the contents of the USS file "/u/user/test.txt" and "/u/user/test.txt"`, + EX2: `Compare the contents of the USS file "/u/user/test.txt" and "/u/user/test.txt" without sequence numbers` } }, LOCAL_FILE_USS_FILE: { - SUMMARY: "Compare content of a local file and a z/os uss file", - DESCRIPTION: "Compare content of a local file and a z/os uss file on your terminal (stdout).", + SUMMARY: "Compare the contents of a local file and a z/OS USS file", + DESCRIPTION: "Compare the contents of a local file and a z/OS USS file in your terminal (stdout).", POSITIONALS: { - LOCALFILEPATH: "The path of the local file you want to compare.", - USSFILEPATH: "The path of the uss file set you want to compare." + LOCALFILEPATH: "The path of the local file you want to compare.", + USSFILEPATH: "The path of the USS file set you want to compare." }, EXAMPLES: { - EX1: `Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt"`, - EX2: `Compare the contents of the local file and the uss file "./a.txt" and "/u/user/test.txt"` + + EX1: `Compare the contents of the local file and the USS file "./a.txt" and "/u/user/test.txt"`, + EX2: `Compare the contents of the local file and the USS file "./a.txt" and "/u/user/test.txt" ` + `without sequence numbers` } }, SPOOL_DD: { - SUMMARY: "Compare content of two spool dds", - DESCRIPTION: "Compare content of two spool dds on your terminal (stdout).", + SUMMARY: "Compare the contents of two spool dds", + DESCRIPTION: "Compare the contents of two spool dds in your terminal (stdout).", POSITIONALS: { - SPOOLDDDESCRIPTION1: "The name of the first job with the id of spool dd", - SPOOLDDDESCRIPTION2: "The name of the second job with the id of spool dd" + SPOOLDDDESCRIPTION1: "The name of the first job with the id of spool dd.", + SPOOLDDDESCRIPTION2: "The name of the second job with the id of spool dd." }, EXAMPLES: { EX1: `Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"`, - EX2: `Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2"` + + EX2: `Compare the contents of the two spool dds "jobName1:jobId1:spoolId1" "jobName2:jobId2:spoolId2" ` + `without sequence numbers` } }, LOCAL_FILE_SPOOL_DD: { - SUMMARY: "Compare content of a local file and a spool dd", - DESCRIPTION: "Compare content of a local-file and a spool-dd on your terminal (stdout).", + SUMMARY: "Compare the contents of a local file and a spool dd", + DESCRIPTION: "Compare the contents of a local file and a spool dd in your terminal (stdout).", POSITIONALS: { - LOCALFILEPATH: "The path of the local file you want to compare.", - SPOOLDDDESCRIPTION: "The name of the job with the id of spool dd" + LOCALFILEPATH: "The path of the local file you want to compare.", + SPOOLDDDESCRIPTION: "The name of the job with the id of spool dd." }, EXAMPLES: { EX1: `Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId"`, - EX2: `Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId"` + + EX2: `Compare the contents of a local-file and a spool dd "./a.txt" "jobName:jobId:spoolId" ` + `without sequence numbers` } }, }, OPTIONS: { BINARY: "Transfer the content of the first data set in binary mode (no EBCDIC to ASCII conversion). If binary mode is set " + - "and the binary2 flag is not set then both datasets are transferred in binary mode.", + "and the binary2 flag is not set then both data sets are transferred in binary mode.", BINARY2: "Transfer the content of the second data set in binary mode.", ENCODING: "Transfer the content of the first data set with encoding mode, which means that data conversion is performed " + "using the file encoding specified. If encoding mode is set and the encoding2 flag is not set both data sets are " + @@ -893,13 +914,15 @@ export default { "lines display. If you want to limit the amount of data returned to only lines with differences use the context " + "lines option to reduce the matching lines to only those before and after non-matching lines. Using the value " + "of 0 strips all matching lines.", - BROWSERVIEW: "Opens the diffs between two given files in browser" + BROWSERVIEW: "Opens the diffs between two given files in browser." } }, HMIGRATE: { + SUMMARY: "Migrate data sets", DESCRIPTION: "Migrate data sets.", ACTIONS: { DATA_SET: { + SUMMARY: "Migrate a data set", DESCRIPTION: "Migrate a data set.", POSITIONALS: { DATASETNAME: "The name of the data set you want to migrate." @@ -914,9 +937,11 @@ export default { } }, HRECALL: { + SUMMARY: "Recall migrated data sets", DESCRIPTION: "Recall migrated data sets.", ACTIONS: { DATA_SET: { + SUMMARY: "Recall a migrated data set", DESCRIPTION: "Recall a migrated data set.", POSITIONALS: { DATASETNAME: "The name of the data set you want to recall." @@ -931,9 +956,11 @@ export default { } }, RENAME: { + SUMMARY: "Rename a data set or member", DESCRIPTION: "Rename a data set or member.", ACTIONS: { DATA_SET: { + SUMMARY: "Rename a data set", DESCRIPTION: "Rename a data set.", POSITIONALS: { BEFOREDSNAME: "The name of the data set that you want to rename.", @@ -946,6 +973,7 @@ export default { } }, DATA_SET_MEMBER: { + SUMMARY: "Rename a data set member", DESCRIPTION: "Rename a data set member.", POSITIONALS: { DSNAME: "The name of the data set the member belongs to.", diff --git a/packages/cli/src/zosfiles/copy/Copy.definition.ts b/packages/cli/src/zosfiles/copy/Copy.definition.ts index 7e385bf8fc..02268576df 100644 --- a/packages/cli/src/zosfiles/copy/Copy.definition.ts +++ b/packages/cli/src/zosfiles/copy/Copy.definition.ts @@ -27,6 +27,7 @@ export const CopyDefinition: ICommandDefinition = { name: "copy", aliases: ["cp"], type: "group", + summary: strings.SUMMARY, description: strings.DESCRIPTION, children: [ DsDefinition, diff --git a/packages/cli/src/zosfiles/copy/ds/Ds.definition.ts b/packages/cli/src/zosfiles/copy/ds/Ds.definition.ts index b3da933f0f..6324f99352 100644 --- a/packages/cli/src/zosfiles/copy/ds/Ds.definition.ts +++ b/packages/cli/src/zosfiles/copy/ds/Ds.definition.ts @@ -26,6 +26,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CO export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: join(__dirname, "Ds.handler"), diff --git a/packages/cli/src/zosfiles/copy/dsclp/Dsclp.definition.ts b/packages/cli/src/zosfiles/copy/dsclp/Dsclp.definition.ts index 6fe542af64..2c3adc3f29 100644 --- a/packages/cli/src/zosfiles/copy/dsclp/Dsclp.definition.ts +++ b/packages/cli/src/zosfiles/copy/dsclp/Dsclp.definition.ts @@ -132,6 +132,7 @@ function buildChainedHandlerArgMapping(optionDefs: (ICommandOptionDefinition | I export const DsclpDefinition: ICommandDefinition = { name: "data-set-cross-lpar", aliases: ["dsclp"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", chainedHandlers: [ diff --git a/packages/cli/src/zosfiles/create/Create.definition.ts b/packages/cli/src/zosfiles/create/Create.definition.ts index c703cffde8..b15b164ad0 100644 --- a/packages/cli/src/zosfiles/create/Create.definition.ts +++ b/packages/cli/src/zosfiles/create/Create.definition.ts @@ -34,6 +34,7 @@ export const CreateDefinition: ICommandDefinition = { name: "create", aliases: ["cre"], type: "group", + summary: strings.SUMMARY, description: strings.DESCRIPTION, children: [PsDefinition, PdsDefinition, diff --git a/packages/cli/src/zosfiles/create/binaryPds/BinaryPDS.definition.ts b/packages/cli/src/zosfiles/create/binaryPds/BinaryPDS.definition.ts index 03bf61c48b..468810ec85 100644 --- a/packages/cli/src/zosfiles/create/binaryPds/BinaryPDS.definition.ts +++ b/packages/cli/src/zosfiles/create/binaryPds/BinaryPDS.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const BinaryPDSDefinition: ICommandDefinition = { name: "data-set-binary", aliases: ["bin"], + summary: strings.ACTIONS.DATA_SET_BINARY.SUMMARY, description: strings.ACTIONS.DATA_SET_BINARY.DESCRIPTION, type: "command", handler: __dirname + "/BinaryPDS.handler", diff --git a/packages/cli/src/zosfiles/create/cPds/CPDS.definition.ts b/packages/cli/src/zosfiles/create/cPds/CPDS.definition.ts index a6c00f95e1..7282db7a60 100644 --- a/packages/cli/src/zosfiles/create/cPds/CPDS.definition.ts +++ b/packages/cli/src/zosfiles/create/cPds/CPDS.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const CPDSDefinition: ICommandDefinition = { name: "data-set-c", aliases: ["dsc"], + summary: strings.ACTIONS.DATA_SET_C.SUMMARY, description: strings.ACTIONS.DATA_SET_C.DESCRIPTION, type: "command", handler: __dirname + "/CPDS.handler", diff --git a/packages/cli/src/zosfiles/create/classicPds/ClassicPDS.definition.ts b/packages/cli/src/zosfiles/create/classicPds/ClassicPDS.definition.ts index e04af04c99..584e590bd4 100644 --- a/packages/cli/src/zosfiles/create/classicPds/ClassicPDS.definition.ts +++ b/packages/cli/src/zosfiles/create/classicPds/ClassicPDS.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const ClassicPDSDefinition: ICommandDefinition = { name: "data-set-classic", aliases: ["classic"], + summary: strings.ACTIONS.DATA_SET_CLASSIC.SUMMARY, description: strings.ACTIONS.DATA_SET_CLASSIC.DESCRIPTION, type: "command", handler: __dirname + "/ClassicPDS.handler", diff --git a/packages/cli/src/zosfiles/create/ds/ds.definition.ts b/packages/cli/src/zosfiles/create/ds/ds.definition.ts index 561b66452c..c7ed711088 100644 --- a/packages/cli/src/zosfiles/create/ds/ds.definition.ts +++ b/packages/cli/src/zosfiles/create/ds/ds.definition.ts @@ -23,6 +23,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: strings.ACTIONS.DATA_SET_LIKE.SUMMARY, description: strings.ACTIONS.DATA_SET_LIKE.DESCRIPTION, type: "command", handler: __dirname + "/ds.handler", diff --git a/packages/cli/src/zosfiles/create/pds/Pds.definition.ts b/packages/cli/src/zosfiles/create/pds/Pds.definition.ts index 7dd72ab8d5..ab2e89ef3c 100644 --- a/packages/cli/src/zosfiles/create/pds/Pds.definition.ts +++ b/packages/cli/src/zosfiles/create/pds/Pds.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const PdsDefinition: ICommandDefinition = { name: "data-set-partitioned", aliases: ["pds"], + summary: strings.ACTIONS.DATA_SET_PARTITIONED.SUMMARY, description: strings.ACTIONS.DATA_SET_PARTITIONED.DESCRIPTION, type: "command", handler: __dirname + "/Pds.handler", diff --git a/packages/cli/src/zosfiles/create/ps/Ps.definition.ts b/packages/cli/src/zosfiles/create/ps/Ps.definition.ts index 9d3a46bceb..46f5200643 100644 --- a/packages/cli/src/zosfiles/create/ps/Ps.definition.ts +++ b/packages/cli/src/zosfiles/create/ps/Ps.definition.ts @@ -25,6 +25,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).CR export const PsDefinition: ICommandDefinition = { name: "data-set-sequential", aliases: ["ps"], + summary: strings.ACTIONS.DATA_SET_SEQUENTIAL.SUMMARY, description: strings.ACTIONS.DATA_SET_SEQUENTIAL.DESCRIPTION, type: "command", handler: __dirname + "/Ps.handler", diff --git a/packages/cli/src/zosfiles/create/vsam/vsam.definition.ts b/packages/cli/src/zosfiles/create/vsam/vsam.definition.ts index a79140b499..8fdf98eb72 100644 --- a/packages/cli/src/zosfiles/create/vsam/vsam.definition.ts +++ b/packages/cli/src/zosfiles/create/vsam/vsam.definition.ts @@ -46,6 +46,7 @@ const vsamRetainFor = Object.assign({}, ...[VsamCreateOptions.retainFor]); export const VsamDefinition: ICommandDefinition = { name: "data-set-vsam", aliases: ["vsam"], + summary: vsamStrings.SUMMARY, description: vsamStrings.DESCRIPTION, type: "command", handler: __dirname + "/vsam.handler", diff --git a/packages/cli/src/zosfiles/delete/Delete.definition.ts b/packages/cli/src/zosfiles/delete/Delete.definition.ts index 654c9337ad..d609aa0ae4 100644 --- a/packages/cli/src/zosfiles/delete/Delete.definition.ts +++ b/packages/cli/src/zosfiles/delete/Delete.definition.ts @@ -30,6 +30,7 @@ export const DeleteDefinition: ICommandDefinition = { name: "delete", aliases: ["del"], type: "group", + summary: strings.SUMMARY, description: strings.DESCRIPTION, children: [ DsDefinition, diff --git a/packages/cli/src/zosfiles/delete/ds/Ds.definition.ts b/packages/cli/src/zosfiles/delete/ds/Ds.definition.ts index 924d670dd5..3d320054d6 100644 --- a/packages/cli/src/zosfiles/delete/ds/Ds.definition.ts +++ b/packages/cli/src/zosfiles/delete/ds/Ds.definition.ts @@ -25,6 +25,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).DE export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: join(__dirname, "Ds.handler"), diff --git a/packages/cli/src/zosfiles/delete/mds/Mds.definition.ts b/packages/cli/src/zosfiles/delete/mds/Mds.definition.ts index a6c2249bbd..745889cfda 100644 --- a/packages/cli/src/zosfiles/delete/mds/Mds.definition.ts +++ b/packages/cli/src/zosfiles/delete/mds/Mds.definition.ts @@ -19,6 +19,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).DE export const MdsDefinition: ICommandDefinition = { name: "migrated-data-set", aliases: ["mds"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: __dirname + "/Mds.handler", diff --git a/packages/cli/src/zosfiles/delete/uss/Uss.definition.ts b/packages/cli/src/zosfiles/delete/uss/Uss.definition.ts index d58a245e5b..3021a288f2 100644 --- a/packages/cli/src/zosfiles/delete/uss/Uss.definition.ts +++ b/packages/cli/src/zosfiles/delete/uss/Uss.definition.ts @@ -25,6 +25,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).DE export const UssDefinition: ICommandDefinition = { name: "uss-file", aliases: ["uf", "uss"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: join(__dirname, "Uss.handler"), diff --git a/packages/cli/src/zosfiles/delete/vsam/Vsam.definition.ts b/packages/cli/src/zosfiles/delete/vsam/Vsam.definition.ts index 57216654ee..08893a34e0 100644 --- a/packages/cli/src/zosfiles/delete/vsam/Vsam.definition.ts +++ b/packages/cli/src/zosfiles/delete/vsam/Vsam.definition.ts @@ -25,6 +25,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).DE export const VsamDefinition: ICommandDefinition = { name: "data-set-vsam", aliases: ["vsam"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: join(__dirname, "Vsam.handler"), diff --git a/packages/cli/src/zosfiles/hMigrate/HMigrate.definition.ts b/packages/cli/src/zosfiles/hMigrate/HMigrate.definition.ts index dfd0c01ea4..6a78581cb5 100644 --- a/packages/cli/src/zosfiles/hMigrate/HMigrate.definition.ts +++ b/packages/cli/src/zosfiles/hMigrate/HMigrate.definition.ts @@ -15,7 +15,7 @@ import { DsDefinition } from "./ds/Ds.definition"; import i18nTypings from "../-strings-/en"; // Does not use the import in anticipation of some internationalization work to be done later. -const { DESCRIPTION } = (require("../-strings-/en").default as typeof i18nTypings).HMIGRATE; +const { DESCRIPTION, SUMMARY } = (require("../-strings-/en").default as typeof i18nTypings).HMIGRATE; /** * hMigrate group definition containing its description and children @@ -25,6 +25,7 @@ export const HMigrateDefinition: ICommandDefinition = { name: "migrate", aliases: ["hmigr", "hMigrate"], type: "group", + summary: SUMMARY, description: DESCRIPTION, children: [ DsDefinition diff --git a/packages/cli/src/zosfiles/hMigrate/ds/Ds.definition.ts b/packages/cli/src/zosfiles/hMigrate/ds/Ds.definition.ts index 96086790d5..8e5b30b2f7 100644 --- a/packages/cli/src/zosfiles/hMigrate/ds/Ds.definition.ts +++ b/packages/cli/src/zosfiles/hMigrate/ds/Ds.definition.ts @@ -20,6 +20,7 @@ const dSStrings = strings.HMIGRATE.ACTIONS.DATA_SET; export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: dSStrings.SUMMARY, description: dSStrings.DESCRIPTION, type: "command", handler: __dirname + "/Ds.handler", diff --git a/packages/cli/src/zosfiles/hRecall/HRecall.definition.ts b/packages/cli/src/zosfiles/hRecall/HRecall.definition.ts index 0612562319..f06883e9ab 100644 --- a/packages/cli/src/zosfiles/hRecall/HRecall.definition.ts +++ b/packages/cli/src/zosfiles/hRecall/HRecall.definition.ts @@ -15,7 +15,7 @@ import { DsDefinition } from "./ds/Ds.definition"; import i18nTypings from "../-strings-/en"; // Does not use the import in anticipation of some internationalization work to be done later. -const { DESCRIPTION } = (require("../-strings-/en").default as typeof i18nTypings).HRECALL; +const { DESCRIPTION, SUMMARY } = (require("../-strings-/en").default as typeof i18nTypings).HRECALL; /** * hRecall group definition containing its description and children @@ -25,6 +25,7 @@ export const HRecallDefinition: ICommandDefinition = { name: "recall", aliases: ["hrec", "hRecall"], type: "group", + summary: SUMMARY, description: DESCRIPTION, children: [ DsDefinition diff --git a/packages/cli/src/zosfiles/hRecall/ds/Ds.definition.ts b/packages/cli/src/zosfiles/hRecall/ds/Ds.definition.ts index 5bbf518b0f..116319a85d 100644 --- a/packages/cli/src/zosfiles/hRecall/ds/Ds.definition.ts +++ b/packages/cli/src/zosfiles/hRecall/ds/Ds.definition.ts @@ -20,6 +20,7 @@ const dSStrings = strings.HRECALL.ACTIONS.DATA_SET; export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: dSStrings.SUMMARY, description: dSStrings.DESCRIPTION, type: "command", handler: __dirname + "/Ds.handler", diff --git a/packages/cli/src/zosfiles/rename/Rename.definition.ts b/packages/cli/src/zosfiles/rename/Rename.definition.ts index c02e0592a8..7341371759 100644 --- a/packages/cli/src/zosfiles/rename/Rename.definition.ts +++ b/packages/cli/src/zosfiles/rename/Rename.definition.ts @@ -26,6 +26,7 @@ export const RenameDefinition: ICommandDefinition = { name: "rename", aliases: [], type: "group", + summary: strings.SUMMARY, description: strings.DESCRIPTION, children: [ DsDefinition, diff --git a/packages/cli/src/zosfiles/rename/ds/Ds.definition.ts b/packages/cli/src/zosfiles/rename/ds/Ds.definition.ts index e641535bf8..732cc653f7 100644 --- a/packages/cli/src/zosfiles/rename/ds/Ds.definition.ts +++ b/packages/cli/src/zosfiles/rename/ds/Ds.definition.ts @@ -20,6 +20,7 @@ const dsStrings = strings.RENAME.ACTIONS.DATA_SET; export const DsDefinition: ICommandDefinition = { name: "data-set", aliases: ["ds"], + summary: dsStrings.SUMMARY, description: dsStrings.DESCRIPTION, type: "command", handler: __dirname + "/Ds.handler", diff --git a/packages/cli/src/zosfiles/rename/dsm/Dsm.definition.ts b/packages/cli/src/zosfiles/rename/dsm/Dsm.definition.ts index 64f385c2b5..e475c63110 100644 --- a/packages/cli/src/zosfiles/rename/dsm/Dsm.definition.ts +++ b/packages/cli/src/zosfiles/rename/dsm/Dsm.definition.ts @@ -20,6 +20,7 @@ const dsmStrings = strings.RENAME.ACTIONS.DATA_SET_MEMBER; export const DsmDefinition: ICommandDefinition = { name: "data-set-member", aliases: ["dsm"], + summary: dsmStrings.SUMMARY, description: dsmStrings.DESCRIPTION, type: "command", handler: __dirname + "/Dsm.handler", diff --git a/packages/cli/src/zosfiles/upload/Upload.definition.ts b/packages/cli/src/zosfiles/upload/Upload.definition.ts index 7f75ab4c19..e35c8cf2ed 100644 --- a/packages/cli/src/zosfiles/upload/Upload.definition.ts +++ b/packages/cli/src/zosfiles/upload/Upload.definition.ts @@ -28,6 +28,7 @@ export const UploadDefinition: ICommandDefinition = { name: "upload", aliases: ["ul"], type: "group", + summary: strings.SUMMARY, description: strings.DESCRIPTION, children: [ FileToDataSetDefinition, diff --git a/packages/cli/src/zosfiles/upload/dtp/DirToPds.definition.ts b/packages/cli/src/zosfiles/upload/dtp/DirToPds.definition.ts index 62b7274fe6..3b5e40ae99 100644 --- a/packages/cli/src/zosfiles/upload/dtp/DirToPds.definition.ts +++ b/packages/cli/src/zosfiles/upload/dtp/DirToPds.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).UP export const DirToPdsDefinition: ICommandDefinition = { name: "dir-to-pds", aliases: ["dtp"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: path.join(__dirname, "/DirToPds.handler"), diff --git a/packages/cli/src/zosfiles/upload/ftds/FileToDataSet.definition.ts b/packages/cli/src/zosfiles/upload/ftds/FileToDataSet.definition.ts index efb848f84c..edae2b7653 100644 --- a/packages/cli/src/zosfiles/upload/ftds/FileToDataSet.definition.ts +++ b/packages/cli/src/zosfiles/upload/ftds/FileToDataSet.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).UP export const FileToDataSetDefinition: ICommandDefinition = { name: "file-to-data-set", aliases: ["ftds"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: path.join(__dirname, "/FileToDataSet.handler"), diff --git a/packages/cli/src/zosfiles/upload/ftu/FileToUSS.definition.ts b/packages/cli/src/zosfiles/upload/ftu/FileToUSS.definition.ts index 7de3726218..1cd07d4b82 100644 --- a/packages/cli/src/zosfiles/upload/ftu/FileToUSS.definition.ts +++ b/packages/cli/src/zosfiles/upload/ftu/FileToUSS.definition.ts @@ -25,6 +25,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).UP export const FileToUSSDefinition: ICommandDefinition = { name: "file-to-uss", aliases: ["ftu"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: path.join(__dirname, "/FileToUSS.handler"), diff --git a/packages/cli/src/zosfiles/upload/stds/StdinToDataSet.definition.ts b/packages/cli/src/zosfiles/upload/stds/StdinToDataSet.definition.ts index 3953d2a670..5e31e016ae 100644 --- a/packages/cli/src/zosfiles/upload/stds/StdinToDataSet.definition.ts +++ b/packages/cli/src/zosfiles/upload/stds/StdinToDataSet.definition.ts @@ -24,6 +24,7 @@ const strings = (require("../../-strings-/en").default as typeof i18nTypings).UP export const StdinToDataSetDefinition: ICommandDefinition = { name: "stdin-to-data-set", aliases: ["stds"], + summary: strings.SUMMARY, description: strings.DESCRIPTION, type: "command", handler: path.join(__dirname, "/StdinToDataSet.handler"), diff --git a/packages/cli/src/zosjobs/-strings-/en.ts b/packages/cli/src/zosjobs/-strings-/en.ts index 78a92effe8..12b0d519b9 100644 --- a/packages/cli/src/zosjobs/-strings-/en.ts +++ b/packages/cli/src/zosjobs/-strings-/en.ts @@ -18,7 +18,7 @@ export default { ACTIONS: { JOB: { SUMMARY: "Cancel a single job by job ID", - DESCRIPTION: "Cancel a single job by job ID", + DESCRIPTION: "Cancel a single job by job ID.", POSITIONALS: { JOB_ID: "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 " + @@ -79,7 +79,7 @@ export default { ACTIONS: { JOB: { SUMMARY: "Delete a single job by job ID", - DESCRIPTION: "Delete a single job by job ID", + DESCRIPTION: "Delete a single job by job ID.", POSITIONALS: { JOB_ID: "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 " + @@ -123,7 +123,7 @@ export default { LIST: { }, OPTIONS: { - MODIFY_VERSION: "Using this option to set X-IBM-Job-Modify-Version to \"1.0\" will make the delete job API aynchronous. " + + MODIFY_VERSION: "Using this option to set X-IBM-Job-Modify-Version to \"1.0\" will make the delete job API asynchronous. " + "Otherwise, it will be synchronous by default." }, SUBMIT: { diff --git a/packages/cli/src/zosmf/check/Check.definition.ts b/packages/cli/src/zosmf/check/Check.definition.ts index ee5990437f..a36a64b0fa 100644 --- a/packages/cli/src/zosmf/check/Check.definition.ts +++ b/packages/cli/src/zosmf/check/Check.definition.ts @@ -15,8 +15,9 @@ import { StatusDefinition } from "./status/Status.definition"; export const CheckCommand: ICommandDefinition = { name: "check", type: "group", + summary: "Check z/OSMF status on a specified system", description: "Confirm that z/OSMF is running on a specified system " + - "and gather information about the z/OSMF server for diagnostic purposes. ", + "and gather information about the z/OSMF server for diagnostic purposes.", children: [ StatusDefinition ] diff --git a/packages/cli/src/zosmf/check/status/Status.definition.ts b/packages/cli/src/zosmf/check/status/Status.definition.ts index a4fc9b744c..f85bb10981 100644 --- a/packages/cli/src/zosmf/check/status/Status.definition.ts +++ b/packages/cli/src/zosmf/check/status/Status.definition.ts @@ -14,6 +14,7 @@ import { ZosmfSession } from "@zowe/zosmf-for-zowe-sdk"; export const StatusDefinition: ICommandDefinition = { name: "status", + summary: "Check z/OSMF status on a specified system", description: "Confirm that z/OSMF is running on a system specified in your profile and gather " + "information about the z/OSMF server for diagnostic purposes. The command outputs properties " + "of the z/OSMF server such as version, hostname, and installed plug-ins.", diff --git a/packages/cli/src/zosmf/list/List.definition.ts b/packages/cli/src/zosmf/list/List.definition.ts index 72181bb241..0645cbc435 100644 --- a/packages/cli/src/zosmf/list/List.definition.ts +++ b/packages/cli/src/zosmf/list/List.definition.ts @@ -15,6 +15,7 @@ import { SystemsDefinition } from "./systems/Systems.definition"; export const ListCommand: ICommandDefinition = { name: "list", type: "group", + summary: "Obtain a list of systems that are defined to a z/OSMF instance", description: "Obtain a list of systems that are defined to a z/OSMF instance.", children: [ SystemsDefinition diff --git a/packages/cli/src/zosmf/list/systems/Systems.definition.ts b/packages/cli/src/zosmf/list/systems/Systems.definition.ts index 94c8f8f0d8..82b8147276 100644 --- a/packages/cli/src/zosmf/list/systems/Systems.definition.ts +++ b/packages/cli/src/zosmf/list/systems/Systems.definition.ts @@ -14,6 +14,7 @@ import { ZosmfSession } from "@zowe/zosmf-for-zowe-sdk"; export const SystemsDefinition: ICommandDefinition = { name: "systems", + summary: "Obtain a list of systems that are defined to a z/OSMF instance", description: "Obtain a list of systems that are defined to a z/OSMF instance.", type: "command", handler: __dirname + "/Systems.handler", diff --git a/packages/cli/src/zostso/start/address-space/AddressSpace.definition.ts b/packages/cli/src/zostso/start/address-space/AddressSpace.definition.ts index 63ef0ccd5a..ecb79b8789 100644 --- a/packages/cli/src/zostso/start/address-space/AddressSpace.definition.ts +++ b/packages/cli/src/zostso/start/address-space/AddressSpace.definition.ts @@ -15,6 +15,7 @@ import { TsoProfileConstants } from "@zowe/zos-tso-for-zowe-sdk"; export const AddressSpaceDefinition: ICommandDefinition = { name: "address-space", aliases: ["as"], + summary: "Start a TSO address space", description: "Start a TSO address space, from which " + "you will receive a token (a.k.a 'servlet-key') for further address space interaction " + "(e.g. termination).", diff --git a/packages/cli/src/zostso/stop/address-space/AddressSpace.definition.ts b/packages/cli/src/zostso/stop/address-space/AddressSpace.definition.ts index c83fe56561..08d5323b1c 100644 --- a/packages/cli/src/zostso/stop/address-space/AddressSpace.definition.ts +++ b/packages/cli/src/zostso/stop/address-space/AddressSpace.definition.ts @@ -14,6 +14,7 @@ import { ICommandDefinition } from "@zowe/imperative"; export const AddressSpaceDefinition: ICommandDefinition = { name: "address-space", aliases: ["as"], + summary: "Stop a TSO address space", description: "Stop a TSO address space, from which " + "you previously started and received a token (a.k.a 'servlet-key').", type: "command", diff --git a/packages/cli/src/zosuss/issue/ssh/Ssh.definition.ts b/packages/cli/src/zosuss/issue/ssh/Ssh.definition.ts index 7c51d75e6d..075d05fa01 100644 --- a/packages/cli/src/zosuss/issue/ssh/Ssh.definition.ts +++ b/packages/cli/src/zosuss/issue/ssh/Ssh.definition.ts @@ -14,6 +14,7 @@ import { ICommandDefinition } from "@zowe/imperative"; export const SshDefinition: ICommandDefinition = { name: "command", aliases: ["cmd", "ssh"], + summary: "Issue a z/OS USS command", description: "Issue a z/OS USS command\n\n" + "Note: The common CLI 'Base Connection Options' of token-type and token-value are not applicable to " + "the ssh command, since the ssh service is not accessible through APIML.", @@ -21,14 +22,14 @@ export const SshDefinition: ICommandDefinition = { type: "command", positionals: [{ name: "command", - description: "z/OS USS command to issue", + description: "z/OS USS command to issue.", type: "string", required: true }], options: [ { name: "cwd", - description: "Working directory in which to execute the command", + description: "Working directory in which to execute the command.", type: "string" }], profile: { diff --git a/packages/imperative/CHANGELOG.md b/packages/imperative/CHANGELOG.md index 037a4c816f..6fa2956518 100644 --- a/packages/imperative/CHANGELOG.md +++ b/packages/imperative/CHANGELOG.md @@ -2,6 +2,10 @@ All notable changes to the Imperative package will be documented in this file. +## Recent Changes + +- Enhancement: Revised help text for consistency [#1756](https://github.com/zowe/zowe-cli/issues/1756) + ## `8.0.0-next.202311291643` - LTS Breaking: Removed check for `ZOWE_EDITOR` environment variable in `ProcessUtils.openInEditor` [#1867](https://github.com/zowe/zowe-cli/issues/1867) diff --git a/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/invoke/__snapshots__/Cmd.cli.invoke.integration.test.ts.snap b/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/invoke/__snapshots__/Cmd.cli.invoke.integration.test.ts.snap index a575628f0d..5dcae7e651 100644 --- a/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/invoke/__snapshots__/Cmd.cli.invoke.integration.test.ts.snap +++ b/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/invoke/__snapshots__/Cmd.cli.invoke.integration.test.ts.snap @@ -6,7 +6,7 @@ exports[`cmd-cli invoke should display help examples for a group 1`] = ` DESCRIPTION ----------- - Connect to token-based authentication services + Connect to token-based authentication services. USAGE ----- diff --git a/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/root/__snapshots__/Cmd.cli.root.integration.test.ts.snap b/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/root/__snapshots__/Cmd.cli.root.integration.test.ts.snap index cbfc7f11e8..a425a85f88 100644 --- a/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/root/__snapshots__/Cmd.cli.root.integration.test.ts.snap +++ b/packages/imperative/__tests__/__integration__/cmd/__tests__/integration/cli/root/__snapshots__/Cmd.cli.root.integration.test.ts.snap @@ -18,18 +18,18 @@ exports[`cmd-cli should display the help 1`] = ` GROUPS ------ - auth Connect to token-based authentication services - auto-format Invoke handlers to test auto-format - chained chained handler test commands - gen-help Commands to test help generator - invalid Invalid definitions - invoke Invoke handlers to test promise reject/fulfill - nested Test a complex structure - profile Validate profile mapping - profiles Create and manage configuration profiles. (deprecated) - read Read some profiles - respond Invoke handlers that will produce messages - validate Validate syntax checking + auth Connect to token-based authentication services + auto-format Invoke handlers to test auto-format + chained chained handler test commands + gen-help Commands to test help generator + invalid Invalid definitions + invoke Invoke handlers to test promise reject/fulfill + nested Test a complex structure + profile Validate profile mapping + profiles Create and manage configuration profiles (deprecated) + read Read some profiles + respond Invoke handlers that will produce messages + validate Validate syntax checking OPTIONS ------- @@ -74,18 +74,18 @@ exports[`cmd-cli should display the help 1`] = ` GROUPS ------ - auth Connect to token-based authentication services - auto-format Invoke handlers to test auto-format - chained chained handler test commands - gen-help Commands to test help generator - invalid Invalid definitions - invoke Invoke handlers to test promise reject/fulfill - nested Test a complex structure - profile Validate profile mapping - profiles Create and manage configuration profiles. (deprecated) - read Read some profiles - respond Invoke handlers that will produce messages - validate Validate syntax checking + auth Connect to token-based authentication services + auto-format Invoke handlers to test auto-format + chained chained handler test commands + gen-help Commands to test help generator + invalid Invalid definitions + invoke Invoke handlers to test promise reject/fulfill + nested Test a complex structure + profile Validate profile mapping + profiles Create and manage configuration profiles (deprecated) + read Read some profiles + respond Invoke handlers that will produce messages + validate Validate syntax checking OPTIONS ------- @@ -118,7 +118,7 @@ exports[`cmd-cli should display the help 1`] = ` \\"success\\": true, \\"exitCode\\": 0, \\"message\\": \\"\\", - \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n A test CLI for the 'cmd' imperative package\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n cmd-cli \\\\n\\\\n Where is one of the following:\\\\n\\\\n GROUPS\\\\n ------\\\\n\\\\n auth Connect to token-based authentication services \\\\n auto-format Invoke handlers to test auto-format \\\\n chained chained handler test commands \\\\n gen-help Commands to test help generator \\\\n invalid Invalid definitions \\\\n invoke Invoke handlers to test promise reject/fulfill \\\\n nested Test a complex structure \\\\n profile Validate profile mapping \\\\n profiles Create and manage configuration profiles. (deprecated)\\\\n read Read some profiles \\\\n respond Invoke handlers that will produce messages \\\\n validate Validate syntax checking \\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --version | -V (boolean)\\\\n\\\\n Display the current version of Cmd Package CLI\\\\n\\\\n --available-commands | --ac (boolean)\\\\n\\\\n Displays a list of available commands\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", + \\"stdout\\": \\"\\\\n DESCRIPTION\\\\n -----------\\\\n\\\\n A test CLI for the 'cmd' imperative package\\\\n\\\\n USAGE\\\\n -----\\\\n\\\\n cmd-cli \\\\n\\\\n Where is one of the following:\\\\n\\\\n GROUPS\\\\n ------\\\\n\\\\n auth Connect to token-based authentication services \\\\n auto-format Invoke handlers to test auto-format \\\\n chained chained handler test commands \\\\n gen-help Commands to test help generator \\\\n invalid Invalid definitions \\\\n invoke Invoke handlers to test promise reject/fulfill \\\\n nested Test a complex structure \\\\n profile Validate profile mapping \\\\n profiles Create and manage configuration profiles (deprecated)\\\\n read Read some profiles \\\\n respond Invoke handlers that will produce messages \\\\n validate Validate syntax checking \\\\n\\\\n OPTIONS\\\\n -------\\\\n\\\\n --version | -V (boolean)\\\\n\\\\n Display the current version of Cmd Package CLI\\\\n\\\\n --available-commands | --ac (boolean)\\\\n\\\\n Displays a list of available commands\\\\n\\\\n GLOBAL OPTIONS\\\\n --------------\\\\n\\\\n --response-format-json | --rfj (boolean)\\\\n\\\\n Produce JSON formatted data from a command\\\\n\\\\n --help | -h (boolean)\\\\n\\\\n Display help text\\\\n\\\\n --help-web | --hw (boolean)\\\\n\\\\n Display HTML help in browser\\\\n\\\\n\\", \\"stderr\\": \\"\\", \\"data\\": {} }" @@ -134,11 +134,11 @@ exports[`cmd-cli should show a list of available commands 1`] = ` "================ISSUING HELP NO OPTIONS=============== cmd-cli auth login fruit - Log in to fruit authentication service + Log in to fruit authentication service. cmd-cli auth logout fruit - Log out of fruit authentication service + Log out of fruit authentication service. cmd-cli auto-format cmd-output diff --git a/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/secure/cli.imperative-test-cli.config.secure.integration.subtest.ts b/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/secure/cli.imperative-test-cli.config.secure.integration.subtest.ts index 120ca60d8c..db4771ff8b 100644 --- a/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/secure/cli.imperative-test-cli.config.secure.integration.subtest.ts +++ b/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/secure/cli.imperative-test-cli.config.secure.integration.subtest.ts @@ -62,7 +62,7 @@ describe("imperative-test-cli config secure", () => { it("should display the help", () => { const response = runCliScript(__dirname + "/../__scripts__/get_help.sh", TEST_ENVIRONMENT.workingDir, ["secure"]); - expect(response.output.toString()).toContain(`prompt for secure configuration properties`); + expect(response.output.toString()).toContain(`Prompt for secure configuration properties.`); }); it("should secure the project config", async () => { diff --git a/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/set/cli.imperative-test-cli.config.set.integration.subtest.ts b/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/set/cli.imperative-test-cli.config.set.integration.subtest.ts index 3bdd5a2090..e223fee09c 100644 --- a/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/set/cli.imperative-test-cli.config.set.integration.subtest.ts +++ b/packages/imperative/__tests__/__integration__/imperative/__tests__/__integration__/cli/config/set/cli.imperative-test-cli.config.set.integration.subtest.ts @@ -59,7 +59,7 @@ describe("imperative-test-cli config set", () => { it("should display the help", () => { const response = runCliScript(__dirname + "/../__scripts__/get_help.sh", TEST_ENVIRONMENT.workingDir, ["set"]); - expect(response.output.toString()).toContain(`create or update a configuration property`); + expect(response.output.toString()).toContain(`Create or update a configuration property.`); }); it("should store a property in plain text", async () => { runCliScript(__dirname + "/../init/__scripts__/init_config.sh", TEST_ENVIRONMENT.workingDir, ["--user-config"]); diff --git a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/CompleteProfilesGroupBuilder.unit.test.ts.snap b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/CompleteProfilesGroupBuilder.unit.test.ts.snap index f13b61ced9..b4b8b367f6 100644 --- a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/CompleteProfilesGroupBuilder.unit.test.ts.snap +++ b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/CompleteProfilesGroupBuilder.unit.test.ts.snap @@ -207,7 +207,7 @@ Object { "options": Array [ Object { "aliases": Array [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", + "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", "name": "force", "required": false, "type": "boolean", @@ -245,7 +245,7 @@ Object { "options": Array [ Object { "aliases": Array [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", + "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", "name": "force", "required": false, "type": "boolean", @@ -383,8 +383,7 @@ Object { "type": "string", }, ], - "summary": "Set the default - profiles for the type-a group", + "summary": "Set the default profiles for the type-a group", "type": "command", }, Object { @@ -414,8 +413,7 @@ Object { "type": "string", }, ], - "summary": "Set the default - profiles for the type-b group", + "summary": "Set the default profiles for the type-b group", "type": "command", }, ], @@ -475,6 +473,7 @@ Object { "deprecatedReplacement": "The 'config init' command", "description": "Create and manage configuration profiles.", "name": "profiles", + "summary": "Create and manage configuration profiles", "type": "group", } `; diff --git a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesDeleteCommandBuilder.unit.test.ts.snap b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesDeleteCommandBuilder.unit.test.ts.snap index 619beaade5..6750e51a20 100644 --- a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesDeleteCommandBuilder.unit.test.ts.snap +++ b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesDeleteCommandBuilder.unit.test.ts.snap @@ -22,7 +22,7 @@ Object { "options": Array [ Object { "aliases": Array [], - "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", + "description": "Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before deletion occurs.", "name": "force", "required": false, "type": "boolean", diff --git a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesSetCommandBuilder.unit.test.ts.snap b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesSetCommandBuilder.unit.test.ts.snap index 912ca6b6cc..ac1a10f2a6 100644 --- a/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesSetCommandBuilder.unit.test.ts.snap +++ b/packages/imperative/src/cmd/__tests__/profiles/builders/__snapshots__/ProfilesSetCommandBuilder.unit.test.ts.snap @@ -28,8 +28,7 @@ Object { "type": "string", }, ], - "summary": "Set the default - profiles for the type-a group", + "summary": "Set the default profiles for the type-a group", "type": "command", } `; diff --git a/packages/imperative/src/imperative/__tests__/plugins/PluginManagementFacility.unit.test.ts b/packages/imperative/src/imperative/__tests__/plugins/PluginManagementFacility.unit.test.ts index 45cfb9f1b1..aed70ad3bb 100644 --- a/packages/imperative/src/imperative/__tests__/plugins/PluginManagementFacility.unit.test.ts +++ b/packages/imperative/src/imperative/__tests__/plugins/PluginManagementFacility.unit.test.ts @@ -214,6 +214,7 @@ describe("Plugin Management Facility", () => { expect(UpdateImpConfig.addCmdGrp).toHaveBeenCalledWith({ name: "plugins", type: "group", + summary: "Install and manage plug-ins", description: "Install and manage plug-ins.", children: [ installDef, diff --git a/packages/imperative/src/imperative/src/auth/__tests__/__snapshots__/CompleteAuthGroupBuilder.unit.test.ts.snap b/packages/imperative/src/imperative/src/auth/__tests__/__snapshots__/CompleteAuthGroupBuilder.unit.test.ts.snap index f82029bf98..1e5ec2e7e8 100644 --- a/packages/imperative/src/imperative/src/auth/__tests__/__snapshots__/CompleteAuthGroupBuilder.unit.test.ts.snap +++ b/packages/imperative/src/imperative/src/auth/__tests__/__snapshots__/CompleteAuthGroupBuilder.unit.test.ts.snap @@ -39,7 +39,7 @@ Object { "base", ], }, - "summary": "Log in to fakeService authentication service", + "summary": "Log in to fakeService authentication service.", "type": "command", }, Object { @@ -73,7 +73,7 @@ Object { "base", ], }, - "summary": "Log in to fakeService authentication service", + "summary": "Log in to fakeService authentication service.", "type": "command", }, ], @@ -110,7 +110,7 @@ Object { "base", ], }, - "summary": "Log out of fakeService authentication service", + "summary": "Log out of fakeService authentication service.", "type": "command", }, Object { @@ -136,7 +136,7 @@ Object { "base", ], }, - "summary": "Log out of fakeService authentication service", + "summary": "Log out of fakeService authentication service.", "type": "command", }, ], @@ -181,7 +181,7 @@ Object { "base", ], }, - "summary": "Log in to fakeService authentication service", + "summary": "Log in to fakeService authentication service.", "type": "command", }, Object { @@ -215,7 +215,7 @@ Object { "base", ], }, - "summary": "Log in to fakeService authentication service", + "summary": "Log in to fakeService authentication service.", "type": "command", }, ], @@ -252,7 +252,7 @@ Object { "base", ], }, - "summary": "Log out of fakeService authentication service", + "summary": "Log out of fakeService authentication service.", "type": "command", }, Object { @@ -278,7 +278,7 @@ Object { "base", ], }, - "summary": "Log out of fakeService authentication service", + "summary": "Log out of fakeService authentication service.", "type": "command", }, ], @@ -288,7 +288,7 @@ Object { "type": "group", }, ], - "description": "Connect to token-based authentication services", + "description": "Connect to token-based authentication services.", "name": "auth", "summary": "Fake auth group summary", "type": "group", @@ -334,7 +334,7 @@ Object { "base", ], }, - "summary": "Log in to fakeService authentication service", + "summary": "Log in to fakeService authentication service.", "type": "command", }, ], @@ -371,7 +371,7 @@ Object { "base", ], }, - "summary": "Log out of fakeService authentication service", + "summary": "Log out of fakeService authentication service.", "type": "command", }, ], @@ -381,8 +381,9 @@ Object { "type": "group", }, ], - "description": "Connect to token-based authentication services", + "description": "Connect to token-based authentication services.", "name": "auth", + "summary": "Connect to token-based authentication services", "type": "group", } `; diff --git a/packages/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts b/packages/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts index 0decbfc9a7..ddc1fe40e8 100644 --- a/packages/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts +++ b/packages/imperative/src/imperative/src/auth/builders/CompleteAuthGroupBuilder.ts @@ -11,7 +11,7 @@ import { ICommandDefinition } from "../../../../cmd"; import { - authCategoryDesc, + authCategoryDesc, authCategorySummary, authLoginGroupDesc, authLoginGroupSummary, authLogoutGroupDesc, authLogoutGroupSummary } from "../../../../messages"; @@ -55,6 +55,7 @@ export class CompleteAuthGroupBuilder { private static defaultAuthGroup: ICommandDefinition = { name: Constants.AUTH_GROUP, + summary: authCategorySummary.message, description: authCategoryDesc.message, type: "group", children: [] diff --git a/packages/imperative/src/imperative/src/config/ConfigManagementFacility.ts b/packages/imperative/src/imperative/src/config/ConfigManagementFacility.ts index f24dcafe6e..22dd7ff124 100644 --- a/packages/imperative/src/imperative/src/config/ConfigManagementFacility.ts +++ b/packages/imperative/src/imperative/src/config/ConfigManagementFacility.ts @@ -62,7 +62,7 @@ export class ConfigManagementFacility { name: "config", type: "group", summary: "Manage JSON project and global configuration", - description: "Manage JSON project and global configuration", + description: "Manage JSON project and global configuration.", children: [ listDefinition, secureDefinition, diff --git a/packages/imperative/src/imperative/src/config/cmd/auto-init/builders/AutoInitCommandBuilder.ts b/packages/imperative/src/imperative/src/config/cmd/auto-init/builders/AutoInitCommandBuilder.ts index 25d40d95b6..32c290f339 100644 --- a/packages/imperative/src/imperative/src/config/cmd/auto-init/builders/AutoInitCommandBuilder.ts +++ b/packages/imperative/src/imperative/src/config/cmd/auto-init/builders/AutoInitCommandBuilder.ts @@ -15,7 +15,7 @@ import { Logger } from "../../../../../../logger"; import { ICommandProfileAutoInitConfig } from "../../../../../../cmd/src/doc/profiles/definition/ICommandProfileAutoInitConfig"; import { ImperativeError } from "../../../../../../error"; import { TextUtils } from "../../../../../../utilities"; -import { autoInitCommandDesc } from "../../../../../../messages"; +import { autoInitCommandDesc, autoInitCommandSummary } from "../../../../../../messages"; import { Constants } from "../../../../../../constants"; import { AutoInitConstants } from "../AutoInitConstants"; @@ -95,10 +95,10 @@ export class AutoInitCommandBuilder implements AbstractCommandBuilder { }; if (autoInitCommand.summary == null) { - autoInitCommand.summary = TextUtils.formatMessage(autoInitCommandDesc.message, {source: this.mConfig.provider}); + autoInitCommand.summary = TextUtils.formatMessage(autoInitCommandSummary.message, {source: this.mConfig.provider}); } if (autoInitCommand.description == null) { - autoInitCommand.description = autoInitCommand.summary; + autoInitCommand.description = TextUtils.formatMessage(autoInitCommandDesc.message, {source: this.mConfig.provider}); } if (this.mProfileType != null) { autoInitCommand.profile = {}; diff --git a/packages/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts b/packages/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts index b9385916da..56c82804f4 100644 --- a/packages/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/edit/edit.definition.ts @@ -20,7 +20,7 @@ export const editDefinition: ICommandDefinition = { name: "edit", type: "command", handler: join(__dirname, "edit.handler"), - summary: "edit config files", + summary: "Edit config files", description: `Edit an existing config file in your system's default text editor.\n\n` + `In a graphical environment, the application associated with JSON files will be launched. ` + `In a command-line environment, vi will be launched. To override the command-line editor used, specify it with the --editor option.`, @@ -42,7 +42,7 @@ export const editDefinition: ICommandDefinition = { { name: "editor", description: `Editor that overrides the default editor for this file type. Set the option to the editor's executable file location ` + - `or the program's name: ie "--editor notepad"`, + `or the program's name: ie "--editor notepad".`, aliases: ["ed"], type: "string", required: false diff --git a/packages/imperative/src/imperative/src/config/cmd/import/import.definition.ts b/packages/imperative/src/imperative/src/config/cmd/import/import.definition.ts index b7ce72c79f..473021c773 100644 --- a/packages/imperative/src/imperative/src/config/cmd/import/import.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/import/import.definition.ts @@ -22,7 +22,7 @@ export const importDefinition: ICommandDefinition = { name: "import", type: "command", handler: join(__dirname, "import.handler"), - summary: "import config files", + summary: "Import config files", description: "Import config files from another location on disk or from an Internet URL.\n\n" + "If the config `$schema` property points to a relative path, the schema will also be imported.", positionals: [ diff --git a/packages/imperative/src/imperative/src/config/cmd/init/init.definition.ts b/packages/imperative/src/imperative/src/config/cmd/init/init.definition.ts index be8b3cf0d3..0b0e0c0239 100644 --- a/packages/imperative/src/imperative/src/config/cmd/init/init.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/init/init.definition.ts @@ -21,7 +21,7 @@ export const initDefinition: ICommandDefinition = { name: "init", type: "command", handler: join(__dirname, "init.handler"), - summary: "init config files", + summary: "Init config files", description: `Initialize config files. Defaults to initializing "${ImperativeConfig.instance.rootCommandName}.config.json" in the current ` + `working directory unless otherwise specified.\n\nUse "--user-config" to init ` + `"${ImperativeConfig.instance.rootCommandName}.config.user.json". Use "--global-config" to initialize the configuration files in your home ` + @@ -72,14 +72,14 @@ export const initDefinition: ICommandDefinition = { { name: "edit", aliases: ["e"], - description: "Open in editor after initializing the configuration", + description: "Open in editor after initializing the configuration.", type: "boolean", conflictsWith: ["dry-run"] }, { name: "editor", description: `Editor that overrides the default editor for this file type. Set the option to the editor's executable file location ` + - `or the program's name: ie "--editor notepad"`, + `or the program's name: ie "--editor notepad".`, aliases: ["ed"], type: "string", implies: ["edit"] diff --git a/packages/imperative/src/imperative/src/config/cmd/list/list.definition.ts b/packages/imperative/src/imperative/src/config/cmd/list/list.definition.ts index ea684df2fb..bbce1be259 100644 --- a/packages/imperative/src/imperative/src/config/cmd/list/list.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/list/list.definition.ts @@ -16,8 +16,8 @@ export const listDefinition: ICommandDefinition = { name: "list", aliases: ["ls"], type: "command", - summary: "list config properties", - description: "List config properties", + summary: "List config properties", + description: "List config properties.", handler: join(__dirname, "list.handler"), positionals: [ { diff --git a/packages/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts b/packages/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts index 1c61041002..0da5f5e8f6 100644 --- a/packages/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/profiles/profiles.definition.ts @@ -20,7 +20,7 @@ export const profilesDefinition: ICommandDefinition = { name: "profiles", type: "command", handler: join(__dirname, "profiles.handler"), - summary: "displays profile paths", + summary: "Displays profile paths", description: "Displays profile paths.", examples: [ { diff --git a/packages/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts b/packages/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts index b1775d9019..8411ebf4f3 100644 --- a/packages/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/report-env/Report-env.definition.ts @@ -22,7 +22,7 @@ export const ReportEnvDefinition: ICommandDefinition = { type: "command", handler: join(__dirname, "Report-env.handler"), summary: "Report the state of your working environment", - description: "Reports key items from your environment and identifies problem conditions", + description: "Reports key items from your environment and identifies problem conditions.", examples: [ { description: "Report information and issues about your working environment", diff --git a/packages/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts b/packages/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts index ebde972f8e..e902517642 100644 --- a/packages/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/schema/schema.definition.ts @@ -20,7 +20,7 @@ export const schemaDefinition: ICommandDefinition = { name: "schema", type: "command", handler: join(__dirname, "schema.handler"), - summary: "dumps the JSON schema for the config", + summary: "Dumps the JSON schema for the config", description: "Dumps the JSON schema for the config. " + "The schema is dynamically created based on your available plugins. " + "Direct the output of this command to a file and include in your config with '$schema' property to get editor completion.", diff --git a/packages/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts b/packages/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts index b903c48be0..efe1eb1c78 100644 --- a/packages/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/secure/secure.definition.ts @@ -16,8 +16,8 @@ export const secureDefinition: ICommandDefinition = { name: "secure", type: "command", handler: join(__dirname, "secure.handler"), - summary: "secure configuration properties", - description: "prompt for secure configuration properties", + summary: "Secure configuration properties", + description: "Prompt for secure configuration properties.", options: [ { name: "global-config", diff --git a/packages/imperative/src/imperative/src/config/cmd/set/set.definition.ts b/packages/imperative/src/imperative/src/config/cmd/set/set.definition.ts index b151990336..b340482dcb 100644 --- a/packages/imperative/src/imperative/src/config/cmd/set/set.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/set/set.definition.ts @@ -16,12 +16,12 @@ export const setDefinition: ICommandDefinition = { name: "set", type: "command", handler: join(__dirname, "set.handler"), - summary: "set configuration property", - description: "create or update a configuration property", + summary: "Set configuration property", + description: "Create or update a configuration property.", positionals: [ { name: "property", - description: "The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting)", + description: "The property to set. You may specify a path using dot notation (e.g. profiles.host1.profiles.service1.properties.setting).", required: true, type: "string" }, diff --git a/packages/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts b/packages/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts index 5808dfe9bd..572dbcd711 100644 --- a/packages/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts +++ b/packages/imperative/src/imperative/src/config/cmd/update-schemas/update-schemas.definition.ts @@ -16,7 +16,7 @@ export const updateSchemasDefinition: ICommandDefinition = { name: "update-schemas", aliases: ["us"], type: "command", - summary: "update schema files", + summary: "Update schema files", description: "Update schema files by looking up the directory structure.\n\n" + "Schema files up in higher level directories will always be updated. " + "To also update schema files down in lower level directories, specify the `--depth` flag.", diff --git a/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts b/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts index 2d498bbba2..cec88ecf4c 100644 --- a/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts +++ b/packages/imperative/src/imperative/src/plugins/PluginManagementFacility.ts @@ -166,6 +166,7 @@ export class PluginManagementFacility { UpdateImpConfig.addCmdGrp({ name: "plugins", type: "group", + summary: "Install and manage plug-ins", description: "Install and manage plug-ins.", children: [ // Done dynamically so that PMFConstants can be initialized diff --git a/packages/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts b/packages/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts index ff53c7e794..34893a117c 100644 --- a/packages/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts +++ b/packages/imperative/src/imperative/src/plugins/cmd/showfirststeps/showfirststeps.definition.ts @@ -24,8 +24,8 @@ export const firststepsDefinition: ICommandDefinition = { name: "show-first-steps", type: "command", aliases: ["fs"], - summary: "Show first steps for a plugin", - description: "Show first steps required to set up plugin for use.", + summary: "Show first steps for a plug-in", + description: "Show first steps required to set up plug-in for use.", handler: join(__dirname, "showfirststeps.handler"), positionals: [ { @@ -39,7 +39,7 @@ export const firststepsDefinition: ICommandDefinition = { // ], examples: [ { - description: `Show first steps for a plugin called 'my-plugin'`, + description: `Show first steps for a plug-in called 'my-plugin'`, options: "my-plugin" } ] diff --git a/packages/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts b/packages/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts index 43e9365004..57947d1915 100644 --- a/packages/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts +++ b/packages/imperative/src/imperative/src/plugins/cmd/validate/validate.definition.ts @@ -40,7 +40,7 @@ export const validateDefinition: ICommandDefinition = { name: "fail-on-error", aliases: ["foe"], type: "boolean", - description: "Enables throwing an error and setting an error code if plugin validation detects an error", + description: "Enables throwing an error and setting an error code if plugin validation detects an error.", required: false, defaultValue: true }, diff --git a/packages/imperative/src/imperative/src/profiles/builders/CompleteProfilesGroupBuilder.ts b/packages/imperative/src/imperative/src/profiles/builders/CompleteProfilesGroupBuilder.ts index 00cd4f39b5..c84f5d08d9 100644 --- a/packages/imperative/src/imperative/src/profiles/builders/CompleteProfilesGroupBuilder.ts +++ b/packages/imperative/src/imperative/src/profiles/builders/CompleteProfilesGroupBuilder.ts @@ -46,6 +46,7 @@ export class CompleteProfilesGroupBuilder { const profileGroup: ICommandDefinition = { name: Constants.PROFILE_GROUP, + summary: "Create and manage configuration profiles", description: "Create and manage configuration profiles.", type: "group", deprecatedReplacement: ProfilesConstants.DEPRECATE_TO_CONFIG_INIT, diff --git a/packages/imperative/src/imperative/src/profiles/builders/ProfilesCreateCommandBuilder.ts b/packages/imperative/src/imperative/src/profiles/builders/ProfilesCreateCommandBuilder.ts index 71714eb419..e79f4df129 100644 --- a/packages/imperative/src/imperative/src/profiles/builders/ProfilesCreateCommandBuilder.ts +++ b/packages/imperative/src/imperative/src/profiles/builders/ProfilesCreateCommandBuilder.ts @@ -11,7 +11,7 @@ import { ProfilesCommandBuilder } from "./ProfilesCommandBuilder"; import { ICommandDefinition, ICommandProfileTypeConfiguration } from "../../../../cmd"; -import { createProfileCommandDesc, createProfileOptionDesc, createProfileOptionOverwriteDesc, +import { createProfileCommandSummary, createProfileOptionDesc, createProfileOptionOverwriteDesc, createProfileDisableDefaultsDesc } from "../../../../messages"; import { Constants } from "../../../../constants"; import { TextUtils } from "../../../../utilities"; @@ -58,7 +58,7 @@ export class ProfilesCreateCommandBuilder extends ProfilesCommandBuilder { const profileCommand: ICommandDefinition = { name: this.mProfileType + "-profile", aliases: [this.mProfileType], - summary: TextUtils.formatMessage(createProfileCommandDesc.message, + summary: TextUtils.formatMessage(createProfileCommandSummary.message, {type: this.mProfileType}), description: this.mSchema.description, type: "command", diff --git a/packages/imperative/src/messages/src/CoreMessages.ts b/packages/imperative/src/messages/src/CoreMessages.ts index 4077a78d2c..d70be82fc8 100644 --- a/packages/imperative/src/messages/src/CoreMessages.ts +++ b/packages/imperative/src/messages/src/CoreMessages.ts @@ -62,7 +62,7 @@ export const createProfilesCommandDesc: IMessageDefinition = { message: `${createProfilesCommandSummary.message}.`, }; -export const createProfileCommandDesc: IMessageDefinition = { +export const createProfileCommandSummary: IMessageDefinition = { message: `Create a {{type}} profile`, }; @@ -139,8 +139,8 @@ export const deleteProfilesCommandDesc: IMessageDefinition = { }; export const deleteProfileForceOptionDesc: IMessageDefinition = { - message: `Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before ` - + ` deletion occurs.` + message: `Force deletion of profile, and dependent profiles if specified. No prompt will be displayed before ` + + `deletion occurs.` }; export const deleteProfileActionDesc: IMessageDefinition = { @@ -198,7 +198,7 @@ export const detailProfileCommandDesc: IMessageDefinition = { message: `Show details of a profile of a selected type.`, }; export const updateProfileActionDesc: IMessageDefinition = { - message: `Update a {{type}} profile`, + message: `Update a {{type}} profile.`, }; export const updateProfileCommandSummary: IMessageDefinition = { @@ -244,8 +244,7 @@ export const setProfileActionDesc: IMessageDefinition = { }; export const setGroupWithOnlyProfilesSummary: IMessageDefinition = { - message: `Set the default - profiles for the {{type}} group` + message: `Set the default profiles for the {{type}} group` }; export const setGroupWithOnlyProfilesCommandDesc: IMessageDefinition = { @@ -345,10 +344,14 @@ export const unexpectedProfileUpdateError: IMessageDefinition = { message: `An unexpected profile update error occurred: \n{{unexpectedError}}` }; -export const authCategoryDesc: IMessageDefinition = { +export const authCategorySummary: IMessageDefinition = { message: `Connect to token-based authentication services` }; +export const authCategoryDesc: IMessageDefinition = { + message: `${authCategorySummary.message}.` +}; + export const authLoginGroupSummary: IMessageDefinition = { message: `Log in to an authentication service` }; @@ -358,7 +361,7 @@ export const authLoginGroupDesc: IMessageDefinition = { }; export const authLoginCommandDesc: IMessageDefinition = { - message: `Log in to {{type}} authentication service` + message: `Log in to {{type}} authentication service.` }; export const authLoginShowTokenDesc: IMessageDefinition = { @@ -374,9 +377,13 @@ export const authLogoutGroupDesc: IMessageDefinition = { }; export const authLogoutCommandDesc: IMessageDefinition = { - message: `Log out of {{type}} authentication service` + message: `Log out of {{type}} authentication service.` }; -export const autoInitCommandDesc: IMessageDefinition = { +export const autoInitCommandSummary: IMessageDefinition = { message: `Automatically generate a config from {{source}}` }; + +export const autoInitCommandDesc: IMessageDefinition = { + message: `${autoInitCommandSummary.message}.` +};