Skip to content

Commit

Permalink
Add Zowe Web Help for master
Browse files Browse the repository at this point in the history
Signed-off-by: zowe-robot <[email protected]>
  • Loading branch information
zowe-robot committed Nov 27, 2024
1 parent 7fcbda9 commit ec8bf78
Show file tree
Hide file tree
Showing 49 changed files with 8,190 additions and 860 deletions.
5,137 changes: 4,300 additions & 837 deletions docs/master/docs/all.html

Large diffs are not rendered by default.

9 changes: 5 additions & 4 deletions docs/master/docs/zowe.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,20 @@ <h2><a href="zowe.html" name="zowe">zowe</a><button id="btn-print" class="no-pri
<h4>Groups</h4>
<ul>
<li><a href="zowe_auth.html">auth</a> - Connect to Zowe API ML authentication service</li>
<li><a href="zowe_cics.html">cics</a> - Interact with IBM CICS programs and transactions.</li>
<li><a href="zowe_cics.html">cics</a> - Interact with IBM CICS programs and transactions.</li>
<li><a href="zowe_config.html">config</a> - Manage JSON project and global configuration</li>
<li><a href="zowe_daemon.html">daemon</a> - Daemon operations</li>
<li><a href="zowe_db2.html">db2</a> - Interact with IBM Db2 for z/OS</li>
<li><a href="zowe_dbm-db2.html">dbm-db2 | dbm</a> - Interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.</li>
<li><a href="zowe_endevor.html">endevor</a> - Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.</li>
<li><a href="zowe_dbm-db2.html">dbm-db2 | dbm</a> - Interact with Db2 using the Broadcom Database Management Solutions for Db2 for z/OS.</li>
<li><a href="zowe_endevor.html">endevor</a> - Endevor plug-in for listing Endevor environment information, working with elements and packages located in specified Endevor instance.</li>
<li><a href="zowe_mq.html">mq</a> - Interact with IBM MQ for z/OS.</li>
<li><a href="zowe_omspool.html">omspool | esf</a> - OM Spool™ Plug-in for Zowe™ CLI</li>
<li><a href="zowe_omview.html">omview | caview | cv</a> - Access Output Management View™ for z/OS data and perform related tasks.</li>
<li><a href="zowe_ops.html">ops</a> - Zowe CLI Plug-in for OPS/MVS®</li>
<li><a href="zowe_plugins.html">plugins</a> - Install and manage plug-ins</li>
<li><a href="zowe_provisioning.html">provisioning | pv</a> - Perform z/OSMF provisioning tasks</li>
<li><a href="zowe_sysview.html">sysview | sv</a> - Integration with SYSVIEW</li>
<li><a href="zowe_zos-console.html">zos-console | console</a> - Issue z/OS console commands and collect responses</li>
<li><a href="zowe_zos-console.html">zos-console | console</a> - Issue z/OS console commands and collect responses</li>
<li><a href="zowe_zos-files.html">zos-files | files</a> - Manage z/OS data sets</li>
<li><a href="zowe_zos-ftp.html">zos-ftp | zftp</a> - z/OS Files and jobs via FTP</li>
<li><a href="zowe_zos-jobs.html">zos-jobs | jobs</a> - Manage z/OS jobs</li>
Expand Down
6 changes: 6 additions & 0 deletions docs/master/docs/zowe_config_secure.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,12 @@ <h4>Options</h4>
</li>
</ul>
</li>
<li>
<p><code>--profile</code> | <code>--pf</code> <em>(string)</em></p>
<ul>
<li>Specify the profile for which you want to configure secure values.</li>
</ul>
</li>
</ul>
<h4>Examples</h4>
<ul>
Expand Down
25 changes: 25 additions & 0 deletions docs/master/docs/zowe_omview.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!DOCTYPE html>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>omview</title>
<link rel="stylesheet" href="../css/bundle-docs.css">
<link rel="stylesheet" href="../css/docs.css">
<article class="markdown-body">
<h2><a href="zowe.html">zowe</a><a href="zowe_omview.html">omview</a><button id="btn-print" class="no-print" onclick="window.print();" title="Print">🖨️</button></h2>
<p>Access Output Management View™ for z/OS data and perform related tasks.</p>
<h4>Usage</h4>
<p>zowe omview &lt;group&gt;</p>
<p>Where &lt;group&gt; is one of the following:</p>
<h4>Groups</h4>
<ul>
<li><a href="zowe_omview_download.html">download | dl</a> - Download OM View report data to local folder.</li>
<li><a href="zowe_omview_export.html">export | exp</a> - Export OM View text report file to local folder.</li>
<li><a href="zowe_omview_get.html">get</a> - Get information from OM View repository.</li>
<li><a href="zowe_omview_list.html">list | ls</a> - List OM View repository, report, and user information.</li>
<li><a href="zowe_omview_search.html">search | find</a> - Search data in a OM View repository.</li>
<li><a href="zowe_omview_set.html">set</a> - Set information in OM View repository.</li>
</ul>
</article>
<script src="../js/bundle-docs.js"></script>
<script src="../js/docs.js"></script>
20 changes: 20 additions & 0 deletions docs/master/docs/zowe_omview_download.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>omview download</title>
<link rel="stylesheet" href="../css/bundle-docs.css">
<link rel="stylesheet" href="../css/docs.css">
<article class="markdown-body">
<h2><a href="zowe.html">zowe</a><a href="zowe_omview.html">omview</a><a href="zowe_omview_download.html">download</a><button id="btn-print" class="no-print" onclick="window.print();" title="Print">🖨️</button></h2>
<p>Download OM View report data to local folder.</p>
<h4>Usage</h4>
<p>zowe omview download &lt;command&gt;</p>
<p>Where &lt;command&gt; is one of the following:</p>
<h4>Commands</h4>
<ul>
<li><a href="zowe_omview_download_report.html">report | r</a> - Download report data.</li>
</ul>
</article>
<script src="../js/bundle-docs.js"></script>
<script src="../js/docs.js"></script>
207 changes: 207 additions & 0 deletions docs/master/docs/zowe_omview_download_report.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,207 @@
<!DOCTYPE html>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>omview download report</title>
<link rel="stylesheet" href="../css/bundle-docs.css">
<link rel="stylesheet" href="../css/docs.css">
<article class="markdown-body">
<h2><a href="zowe.html">zowe</a><a href="zowe_omview.html">omview</a><a href="zowe_omview_download.html">download</a><a href="zowe_omview_download_report.html">report</a><button id="btn-print" class="no-print" onclick="window.print();" title="Print">🖨️</button></h2>
<p>Download report data.<br>
Optionally convert text report to PDF.</p>
<h4>Usage</h4>
<p>zowe omview download report &lt;repositoryId&gt; &lt;reportHandle&gt; [fileTarget] [options]</p>
<h4>Positional Arguments</h4>
<ul>
<li>
<p><code>repositoryId</code> <em>(number)</em></p>
<ul>
<li>Repository identifier.</li>
</ul>
</li>
<li>
<p><code>reportHandle</code> <em>(string)</em></p>
<ul>
<li>Report handle.</li>
</ul>
</li>
<li>
<p><code>fileTarget</code> <em>(string)</em></p>
<ul>
<li>Local file path.<br>
If the path represents a directory location, the report will be downloaded into that directory using a default file name.<br>
If the path does not represent a directory location, the report will be downloaded into the specified path.<br>
If the path is not specified, the file will be saved to the current working directory using the default file name.<br>
Any missing directories will be created. If the target file already exists, the file will be overwritten.</li>
</ul>
</li>
</ul>
<h4>Options</h4>
<ul>
<li>
<p><code>--convert-to-pdf</code> | <code>--to-pdf</code> <em>(boolean)</em></p>
<ul>
<li>
<p>Converts text report to PDF.</p>
<p>Default value: false</p>
</li>
</ul>
</li>
<li>
<p><code>--page-orientation</code> | <code>--orientation</code> <em>(string)</em></p>
<ul>
<li>
<p>Page orientation for converted PDF.</p>
<p>Default value: PORTRAIT<br>
Allowed values: PORTRAIT, LANDSCAPE</p>
</li>
</ul>
</li>
<li>
<p><code>--font-size</code> | <code>--font</code> <em>(number)</em></p>
<ul>
<li>
<p>Font size for converted PDF.</p>
<p>Default value: 12</p>
</li>
</ul>
</li>
<li>
<p><code>--green-bar</code> <em>(boolean)</em></p>
<ul>
<li>
<p>Include green-bar background in converted PDF.</p>
<p>Default value: false</p>
</li>
</ul>
</li>
<li>
<p><code>--pages</code> <em>(string)</em></p>
<ul>
<li>
<p>Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.<br>
Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.</p>
<p>Allowed values: (\d+(-\d+)?)(,(\d+(-\d+)?))*</p>
</li>
</ul>
</li>
<li>
<p><code>--content-filter</code> | <code>--filter</code> <em>(string)</em></p>
<ul>
<li>Filter text report content using a permanent filter definition.<br>
If the product instance does not support this feature, this option is ignored.</li>
</ul>
</li>
</ul>
<h4>OM Web Viewer Connection Options</h4>
<ul>
<li>
<p><code>--host</code> | <code>--hostname</code> <em>(string)</em></p>
<ul>
<li>Hostname or ip address of the target OM Web Viewer instance.</li>
</ul>
</li>
<li>
<p><code>--port</code> <em>(number)</em></p>
<ul>
<li>
<p>Port of the target OM Web Viewer instance.</p>
<p>Default value: 443</p>
</li>
</ul>
</li>
<li>
<p><code>--user</code> | <code>--username</code> <em>(string)</em></p>
<ul>
<li>User name used to authenticate against the target OM Web Viewer instance.</li>
</ul>
</li>
<li>
<p><code>--password</code> <em>(string)</em></p>
<ul>
<li>Password used to authenticate against the target OM Web Viewer instance.</li>
</ul>
</li>
<li>
<p><code>--base-path</code> <em>(string)</em></p>
<ul>
<li>
<p>Context name of the target OM Web Viewer instance.</p>
<p>Default value: web-viewer</p>
</li>
</ul>
</li>
<li>
<p><code>--protocol</code> <em>(string)</em></p>
<ul>
<li>
<p>Protocol of the target OM Web Viewer instance.</p>
<p>Default value: https<br>
Allowed values: http, https</p>
</li>
</ul>
</li>
</ul>
<h4>Profile Options</h4>
<ul>
<li>
<p><code>--omview-profile</code> | <code>--omview-p</code> <em>(string)</em></p>
<ul>
<li>The name of a (omview) profile to load for this command execution.</li>
</ul>
</li>
<li>
<p><code>--caview-profile</code> | <code>--caview-p</code> <em>(string)</em></p>
<ul>
<li>The name of a (caview) profile to load for this command execution.</li>
</ul>
</li>
<li>
<p><code>--base-profile</code> | <code>--base-p</code> <em>(string)</em></p>
<ul>
<li>The name of a (base) profile to load for this command execution.</li>
</ul>
</li>
</ul>
<h4>Base Connection Options</h4>
<ul>
<li>
<p><code>--reject-unauthorized</code> | <code>--ru</code> <em>(boolean)</em></p>
<ul>
<li>
<p>Reject self-signed certificates.</p>
<p>Default value: true</p>
</li>
</ul>
</li>
<li>
<p><code>--token-type</code> | <code>--tt</code> <em>(string)</em></p>
<ul>
<li>The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.</li>
</ul>
</li>
<li>
<p><code>--token-value</code> | <code>--tv</code> <em>(string)</em></p>
<ul>
<li>The value of the token to pass to the API.</li>
</ul>
</li>
<li>
<p><code>--cert-file</code> <em>(local file path)</em></p>
<ul>
<li>
<p>The file path to a certificate file to use for authentication.</p>
<p>Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.</p>
</li>
</ul>
</li>
<li>
<p><code>--cert-key-file</code> <em>(local file path)</em></p>
<ul>
<li>The file path to a certificate key file to use for authentication</li>
</ul>
</li>
</ul>
</article>
<script src="../js/bundle-docs.js"></script>
<script src="../js/docs.js"></script>
20 changes: 20 additions & 0 deletions docs/master/docs/zowe_omview_export.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<!DOCTYPE html>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta http-equiv="X-UA-Compatible" content="ie=edge">
<title>omview export</title>
<link rel="stylesheet" href="../css/bundle-docs.css">
<link rel="stylesheet" href="../css/docs.css">
<article class="markdown-body">
<h2><a href="zowe.html">zowe</a><a href="zowe_omview.html">omview</a><a href="zowe_omview_export.html">export</a><button id="btn-print" class="no-print" onclick="window.print();" title="Print">🖨️</button></h2>
<p>Export OM View text report file to local folder.</p>
<h4>Usage</h4>
<p>zowe omview export &lt;command&gt;</p>
<p>Where &lt;command&gt; is one of the following:</p>
<h4>Commands</h4>
<ul>
<li><a href="zowe_omview_export_report.html">report | r</a> - Export text report to spreadsheet.</li>
</ul>
</article>
<script src="../js/bundle-docs.js"></script>
<script src="../js/docs.js"></script>
Loading

0 comments on commit ec8bf78

Please sign in to comment.