Skip to content

Commit

Permalink
Merge pull request #3291 from zowe/archiving-v2.12.x-release
Browse files Browse the repository at this point in the history
Archiving v2.12.x release
  • Loading branch information
samanthasusu authored Dec 5, 2023
2 parents 23e4192 + c1f0547 commit 8c713f5
Show file tree
Hide file tree
Showing 2,211 changed files with 514,472 additions and 4 deletions.
1 change: 1 addition & 0 deletions docs/user-guide/certificate-configuration-scenarios.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,7 @@ PEM format certificate authorities can be imported and trusted.
```
Your yaml file is now configured to enable Zowe to use a file-based PKCS12 keystore to import a certificate generted by another CA.
## Scenario 3: Use a z/OS keyring-based keystore with Zowe generated certificates
Use the following procedure to configure the `zowe.setup.certificate` section in your yaml file to enable Zowe to use a z/OS keyring-based keystore with Zowe generated certificates.
1. Set the `type` of the certificate storage to one of the following keyring types:
Expand Down
12 changes: 8 additions & 4 deletions docs/user-guide/cli-using-formatting-environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,17 @@ Transform an option into the proper format for a Zowe CLI environment variable,
* Convert lowercase letters in arguments/options to uppercase letters.
* Convert hyphens in arguments/options to underscores.

**Tip:** Refer to your operating system documentation for information about how to set and get environment variables. The procedure varies between Windows, Mac, and various versions of Linux.
:::tip
Refer to your operating system documentation for information about how to set and get environment variables. The procedure varies between Windows, Mac, and various versions of Linux.
:::

**Examples:**
## Examples of transformed CLI options

The following table provides examples of CLI options and the corresponding environment variable to which you can define a value:

| Command Option | Environment Variable | Use Case |
| ----------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| -------------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `--user` | `ZOWE_OPT_USER` | Define your mainframe username to an environment variable to avoid specifying it on all commands or profiles. |
| `--reject-unauthorized` | `ZOWE_OPT_REJECT_UNAUTHORIZED` | Define a value of `true` to the `--reject-unauthorized` flag when you always require the flag and do not want to specify it on all commands or profiles. |
| `--reject-unauthorized` | `ZOWE_OPT_REJECT_UNAUTHORIZED` | Define a value of `true` to the `--reject-unauthorized` flag when you always require the flag and do not want to specify it on all commands or profiles. |
| `--editor` | `ZOWE_OPT_EDITOR` | Define an editor that Zowe CLI uses to open files. The value can be either the editor's executable file location or the name of a program (for example, *notepad* on Windows or *nano* on Linux).|

Binary file added static/v2.12.x/CLIReference_Zowe.pdf
Binary file not shown.
Binary file not shown.
Binary file added static/v2.12.x/Zowe_Overview.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions static/v2.12.x/typedoc/assets/css/main.css

Large diffs are not rendered by default.

Binary file added static/v2.12.x/typedoc/assets/images/icons.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/v2.12.x/typedoc/assets/images/widgets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
51 changes: 51 additions & 0 deletions static/v2.12.x/typedoc/assets/js/main.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions static/v2.12.x/typedoc/assets/js/search.json

Large diffs are not rendered by default.

Large diffs are not rendered by default.

354 changes: 354 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_core_for_zowe_sdk.login.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

354 changes: 354 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_core_for_zowe_sdk.logout.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2,137 changes: 2,137 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_core_for_zowe_sdk.profileconstants.html

Large diffs are not rendered by default.

489 changes: 489 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_core_for_zowe_sdk.services.html

Large diffs are not rendered by default.

1,334 changes: 1,334 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_core_for_zowe_sdk.zosmfheaders.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

1,076 changes: 1,076 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_imperative.abstractcommandyargs.html

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

2,702 changes: 2,702 additions & 0 deletions static/v2.12.x/typedoc/classes/_zowe_imperative.abstractprofilemanager.html

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,306 @@
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>AbstractProfileManagerFactory | Zowe Node.js SDK - v2.12.0</title>
<meta name="description" content="Documentation for Zowe Node.js SDK - v2.12.0">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">Zowe Node.js SDK - v2.12.0</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_zowe_imperative.html">@zowe/imperative</a>
</li>
<li>
<a href="_zowe_imperative.abstractprofilemanagerfactory.html">AbstractProfileManagerFactory</a>
</li>
</ul>
<h1>Class AbstractProfileManagerFactory&lt;T&gt;</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Abstract profile manager (implemented by imperative, etc.)</p>
</div>
<dl class="tsd-comment-tags">
<dt>export</dt>
<dd></dd>
<dt>abstract</dt>
<dd></dd>
<dt>implements</dt>
<dd><p>{IProfileManagerFactory<T>}</p>
</dd>
</dl>
</div>
</section>
<section class="tsd-panel tsd-type-parameters">
<h3>Type parameters</h3>
<ul class="tsd-type-parameters">
<li>
<h4>T<span class="tsd-signature-symbol">: </span><a href="../interfaces/_zowe_imperative.iprofiletypeconfiguration.html" class="tsd-signature-type">IProfileTypeConfiguration</a></h4>
<div class="tsd-comment tsd-typography">
<div class="lead">
</div>
</div>
</li>
</ul>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">AbstractProfileManagerFactory</span>
<ul class="tsd-hierarchy">
<li>
<a href="_zowe_imperative.imperativeprofilemanagerfactory.html" class="tsd-signature-type">ImperativeProfileManagerFactory</a>
</li>
<li>
<a href="_zowe_imperative.basicprofilemanagerfactory.html" class="tsd-signature-type">BasicProfileManagerFactory</a>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel">
<h3>Implements</h3>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/_zowe_imperative.iprofilemanagerfactory.html" class="tsd-signature-type">IProfileManagerFactory</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_zowe_imperative.abstractprofilemanagerfactory.html#getmanager" class="tsd-kind-icon">get<wbr>Manager</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getmanager" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Manager</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Manager<span class="tsd-signature-symbol">(</span>type<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_zowe_imperative.abstractprofilemanager.html" class="tsd-signature-type">AbstractProfileManager</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/_zowe_imperative.iprofilemanagerfactory.html">IProfileManagerFactory</a>.<a href="../interfaces/_zowe_imperative.iprofilemanagerfactory.html#getmanager">getManager</a></p>
<ul>
<li>Defined in <a href="https://github.com/zowe/imperative/blob/v5.18.2/packages/profiles/src/abstract/AbstractProfileManagerFactory.ts#L31">@zowe/imperative/packages/profiles/src/abstract/AbstractProfileManagerFactory.ts:31</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Returns and instance of the profile manager for the type specified.</p>
</div>
<dl class="tsd-comment-tags">
<dt>abstract</dt>
<dd></dd>
<dt>memberof</dt>
<dd><p>AbstractProfileManagerFactory</p>
</dd>
</dl>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>type: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>the profile type</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_zowe_imperative.abstractprofilemanager.html" class="tsd-signature-type">AbstractProfileManager</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">&gt;</span></h4>
<ul>
<li>The manager</li>
</ul>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_core_for_zowe_sdk.html">@zowe/core-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/_zowe_imperative.html">@zowe/imperative</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_provisioning_for_zowe_sdk.html">@zowe/provisioning-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_console_for_zowe_sdk.html">@zowe/zos-<wbr>console-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_files_for_zowe_sdk.html">@zowe/zos-<wbr>files-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_jobs_for_zowe_sdk.html">@zowe/zos-<wbr>jobs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_logs_for_zowe_sdk.html">@zowe/zos-<wbr>logs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_tso_for_zowe_sdk.html">@zowe/zos-<wbr>tso-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_uss_for_zowe_sdk.html">@zowe/zos-<wbr>uss-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_workflows_for_zowe_sdk.html">@zowe/zos-<wbr>workflows-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zosmf_for_zowe_sdk.html">@zowe/zosmf-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-module">
<a href="../modules/_zowe_core_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/core-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-module">
<a href="../modules/_zowe_imperative.html" class="tsd-kind-icon">@zowe/imperative</a>
<ul>
<li class="current tsd-kind-class tsd-parent-kind-module tsd-has-type-parameter">
<a href="_zowe_imperative.abstractprofilemanagerfactory.html" class="tsd-kind-icon">Abstract<wbr>Profile<wbr>Manager<wbr>Factory</a>
<ul>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_zowe_imperative.abstractprofilemanagerfactory.html#getmanager" class="tsd-kind-icon">get<wbr>Manager</a>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-module">
<a href="../modules/_zowe_provisioning_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/provisioning-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_console_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>console-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_files_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>files-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_jobs_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>jobs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_logs_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>logs-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_tso_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>tso-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_uss_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>uss-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zos_workflows_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zos-<wbr>workflows-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/_zowe_zosmf_for_zowe_sdk.html" class="tsd-kind-icon">@zowe/zosmf-<wbr>for-<wbr>zowe-<wbr>sdk</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Loading

0 comments on commit 8c713f5

Please sign in to comment.