Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update CLI plug-in docs around creating user profiles #3515

Merged
merged 2 commits into from
Mar 11, 2024
Merged

Update CLI plug-in docs around creating user profiles #3515

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4d79be
Update CLI plug-in docs around creating user profiles
zFernand0 Mar 8, 2024
9a22015
address PR feedback
zFernand0 Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 29 additions & 48 deletions docs/user-guide/cli-ftpplugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,45 +39,26 @@ Use one of the following methods to install or update the plug-in:

## Creating a user profile

You create a zftp profile to avoid entering your connection details each time that you issue a command. You can create multiple profiles and switch between them as needed. Use one of the following methods to create a profile:
zFernand0 marked this conversation as resolved.
Show resolved Hide resolved
After you install the plug-in, 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.
zFernand0 marked this conversation as resolved.
Show resolved Hide resolved

- **Create plug-in profiles using a configuration file:** Specify your profile and connection details in the `zowe.config.json` configuration file.
**Follow these steps:**
1. Install the z/OS FTP Plug-in for Zowe CLI
2. Create an FTP profile:

- **Create plug-in profiles using a command:** Issue the `zowe profiles create` command to create the profile.

We recommend that you create profiles using the configuration file. We do not recommend using profile commands because we are removing them in a future major release.

### Creating plug-in profiles using a configuration file

When you issue various `zowe config` commands, such as `init`, `auto-init`, and `convert-profiles`, they create a `zowe.config.json` configuration file. When you install the z/OS FTP plug-in, the commands create an entry for a `zftp profile` in your `zowe.config.json` file.

Alternatively, you can create a zftp profile manually by adding a section that contains the configuration details to your `zowe.config.json` configuration file.

1. Browse to the following directory: `C:\Users\<username>\.zowe`

2. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ.
```
zowe config init
```
3. If using a non-standard port, set the port number to your FTP connection:

NOTE: If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc`
```
zowe config set profiles.zftp.properties.port <port number>
```
4. If using a insecure connection, set the secureFtp value to false:

3. Add code to the "profiles" section as shown in the following example:

```
"Your_zftp_profile": {
"type": "zftp",
"properties": {
"host": "Your_host_name",
"port": Your_port_number,
"secureFtp": true
},
"secure": [
"user",
"password"
]
}
zowe config set profiles.zftp.properties.secureFtp false
```
**Note:** The value of the “`secureftp`" option is defined as true by default. We recommend that you specify this value when FTPS (FTP over SSL) is enabled in the z/OS FTP service. FTPS is not equivalent to SFTP (FTP over SSH). SFTP is not currently supported.

4. Save the file

You can now use your profile when you issue commands in the zftp command group.

Expand All @@ -90,27 +71,27 @@ The following steps describe how to create a profile using the `zowe profiles cr
zowe profiles create zftp <profile_name> --host <host> --port <port> --user <user> --password <password>
```

**`profile_name`:**
**`profile_name`:**

Specifies a name for your profile.
**`host`:**

**`host`:**

Specifies the host name for the instance.
**`user`:**

**`user`:**

Specifies your user name to log in to the instance.
**`password`:**

**`password`:**

Specifies your password to log in to the instance.
**`port`:**

**`port`:**

Specifies the port number to connect to the instance.

**Example:**
**Example:**
```
zowe profiles create zftp-profile LPAR1 --host ftp.zowe.org --port 21 --user zowe --password zowepass --secure-ftp
```
Expand All @@ -133,5 +114,5 @@ For example, you can use one of the following methods to download a data set:
```
- Download a data set without using a default profile:
```
zowe zftp download data-set USERHLQ.DATASET.NAME --host <hostname> --port 21 --user <User_ID> --password <password> --secure-ftp false
zFernand0 marked this conversation as resolved.
Show resolved Hide resolved
zowe zftp download data-set USERHLQ.DATASET.NAME --host <hostname> --port 21 --user <User_ID> --password <password> --secure-ftp false
```
78 changes: 7 additions & 71 deletions docs/user-guide/cli-mqplugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,83 +30,19 @@ Use one of the following methods to install or update the plug-in:

## Creating a user profile

You create an mq profile to avoid entering your connection details each time that you issue a command. You can create multiple profiles and switch between them as needed. Use one of the following methods to create a profile:
After you install the plug-in, create an MQ profile. An MQ profile is recommended to issue commands to the MQ resource. MQ profiles contain your host, port, user name, and password for the IBM MQ REST API server of your choice. You can create multiple profiles and switch between them as needed.

- **Create plug-in profiles using a configuration file:** Specify your profile and connection details in the `zowe.config.json` configuration file.
**Follow these steps:**
1. Install the IBM MQ Plug-in for Zowe CLI.
2. Create an MQ profile:

- **Create plug-in profiles using a command:** Issue the `zowe profiles create` command to create the profile.

We recommend that you create profiles using the configuration file. We do not recommend using profile commands because we are removing them in a future major release.


### Creating plug-in profiles using a configuration file

When you issue various zowe config commands, such as `init`, `auto-init`, and `convert-profiles`, they create a `zowe.config.json` configuration file. When you install the MQ plug-in, the commands create an entry for an `mq profile` in your `zowe.config.json` file.

Alternatively, you can create a mq profile manually by adding a section that contains the configuration details to your `zowe.config.json`ok configuration file.

1. Browse to the following directory `C:\Users\<username>\.zowe`

2. Open the `zowe.config.json` configuration file using a text editor or IDE, such as Visual Studio Code or IntelliJ.

**NOTE:** If the file does not exist, issue the following command to create the configuration file: `zowe config init --gc`

3. Add code to the "profiles" section as shown in the following example:

**Example:**
```
"Your_mq_profile": {
"type": "mq",
"properties": {
"host": "Your_host_name",
"port": Your_port_number
},
"secure": [
"user",
"password"
]
}
zowe config init
```
4. Save the file

You can now use your profile when you issue commands in the mq command group.

### Creating plug-in profiles using a command

The following steps describe how to create a profile using the `zowe profiles create` command.

1. Open a terminal window and issue the following command:
3. Set the port number to your MQ port:

```
zowe profiles create mq <profile_name> --host <host> --port <port> --user <user> --password <password>
zowe config set profiles.mq.properties.port <port number>
```

**`profile_name`:**

Specifies a name for your profile.

**`host`:**

Specifies the host name for the instance.

**`user`:**

Specifies your user name to log in to the instance.

**`password`:**

Specifies your password to log in to the instance.

**`port`:**

Specifies the port number to connect to the instance.

**Example:**

```
zowe profiles create mq-profile queue1 --host mq.zowe.org --port 1443 --user zowe --password zowepass
```

2. Press Enter. The result of the command displays as a success or failure message.

You can now use your profile when you issue commands in the mq command group.
Loading