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

Specified the port in the Getting Started -> Basic Usage page in the documentation #238

Merged
merged 4 commits into from
Dec 1, 2023
Merged

Specified the port in the Getting Started -> Basic Usage page in the documentation #238

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54cb07b
Update doc
Myrausman Nov 29, 2023
5ea200a
Merge branch 'zowe:main' into main
Myrausman Nov 29, 2023
9f154a0
Update examples of basic usage
Myrausman Nov 29, 2023
a17bdb6
Update doc of basic usage
Myrausman Nov 30, 2023
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
17 changes: 9 additions & 8 deletions docs/source/usage/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,22 +7,23 @@ Create a dictionary to handle communication with the plug-in:
.. code-block:: python

from zowe.zos_console_for_zowe_sdk import Console
connection = {
"host_url": "'<host address>'",
profile = {
"host": "<host address>",
"port" : 443 , # Include the port if different from the default (443)
"user": "<user>",
"password": "<password>",
}

my_console = Console(connection)
my_console = Console(profile)

Alternatively you can use an existing Zowe CLI profile instead:

.. code-block:: python

from zowe.zos_console_for_zowe_sdk import Console
from zowe.zos_console_for_zowe_sdk import Console
from zowe.core_for_zowe_sdk import ProfileManager

connection = {
"plugin_profile": "<profile name>>"
}
# Load the profile using ProfileManager
profile = ProfileManager().load(profile_name="<profile name>")

my_console = Console(connection)
my_console = Console(profile)
Loading