Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
Signed-off-by: zFernand0 <[email protected]>
  • Loading branch information
zFernand0 committed Mar 7, 2024
1 parent 98f8f40 commit 6f5de49
Show file tree
Hide file tree
Showing 4 changed files with 90 additions and 78 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,26 +87,27 @@ Before you install the plug-in, meet the following requirements:
5. [Create a user profile](#create-a-user-profile).
## Create a User Profile
## Creating a user profile
You can create a `zftp` user profile to avoid typing your connection details on every command. A `zftp` profile contains the host, port, username, and password for the z/OS you will connect. You can create multiple profiles and switch between them as needed.
After you install the plug-in, you create an FTP profile. An FTP profile is recommended to issue commands to via FTP. FTP profiles contain your host, port, user name, and password for connect to z/OS using FTP. You can create multiple profiles and switch between them as needed.
**Follow these steps:**
1. Create a zftp profile:
1. Install the z/OS FTP Plug-in for Zowe CLI
2. Create an FTP profile:
```
zowe profiles create zftp <profile name> -H <host> -u <user> -p <password> -P <port> --secure-ftp true
zowe config init
```
3. If using a non-standard port, set the port number to your FTP connection:
The result of the command displays as a success or failure message. You can use your profile when you issue commands in the zftp command group.
**Notice** The option `--secure-ftp true` is strongly recommended if FTPS (FTP over SSL) is enabled in z/OS FTP service. This is not the same as SFTP (FTP over SSH).
**Tip:** For more information about the syntax, actions, and options, for a profiles create command, open Zowe CLI and issue the following command:
```
zowe config set profiles.zftp.properties.port <port number>
```
4. If using a insecure connection, set the secureFtp value to false:
```
zowe profiles create zftp -h
```
```
zowe config set profiles.zftp.properties.secureFtp false
```
## Running tests
Expand Down
126 changes: 63 additions & 63 deletions npm-shrinkwrap.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@
"@types/node": "^18.19.21",
"@typescript-eslint/eslint-plugin": "^7.1.1",
"@typescript-eslint/parser": "^7.1.1",
"@zowe/cli": "^8.0.0-next.202403041352",
"@zowe/cli-test-utils": "^8.0.0-next.202403041352",
"@zowe/imperative": "^8.0.0-next.202403041352",
"@zowe/cli": "^8.0.0-next.202403061549",
"@zowe/cli-test-utils": "^8.0.0-next.202403061549",
"@zowe/imperative": "^8.0.0-next.202403061549",
"env-cmd": "^10.1.0",
"eslint": "^8.57.0",
"eslint-plugin-jest": "^27.9.0",
Expand Down
11 changes: 11 additions & 0 deletions release.config.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,14 @@
/*
* This program and the accompanying materials are made available under the terms of the
* Eclipse Public License v2.0 which accompanies this distribution, and is available at
* https://www.eclipse.org/legal/epl-v20.html
*
* SPDX-License-Identifier: EPL-2.0
*
* Copyright Contributors to the Zowe Project.
*
*/

module.exports = {
branches: [
{
Expand Down

0 comments on commit 6f5de49

Please sign in to comment.